Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Introduction

Welcome to the documentation of the Gutenberg project!

The home of the Gutenberg project is its GitHub repository: KSIUJ/gutenberg. It hosts the project's source code, the source of this book and the list of issues and planned features.

Book structure

This book is divided into two sections Admin documentation and Internals.

The Admin documentation section is intended for system administrators who manage a self-hosted Gutenberg instance.

The API documentation section documents Gutenberg's REST API and Internet Printing Protocol (IPP) implementation.

The Internals section is mainly intended for Gutenberg's contributors. It explains the codebase structure, describes the design choices and their rationale. It also describes the suggested implementation and design considerations for planned features.

Contributing to this book

This source of this book is in the same GitHub repository as Gutenberg's code, in the docs directory. The book has been created using mdBook. These mdBook plugins are also installed:

To contribute, fork this repository and create a pull request with your changes.