Books#

Books are your documentation and writing projects. They are collections of related documents, media, and settings, organized to help you structure your writing or documentation projects. In this section, you will learn how to create, manage, and configure a book.

Book ID#

When creating a book, you need to choose a book ID. The book ID serves two main purposes:

  • it’s unique identification of a book across all books in Documatt, yours and others’ too.

  • it will become a part of the URL web address when you publish your book.

The book ID can’t be changed later, so choose its name wisely. We recommend using name-project format. Where name is your or your organization’s name. For example, at Documatt, we name books like documatt-help, documatt-wiki, or documatt-userguide, etc.

The book ID has very strict naming rules:

  • only allowed chars are lowercase a-z, numbers 0-9, and hyphen -

  • cannot contain two or more consecutive - characters

  • cannot start or end with -

  • cannot start with documatt

  • have at least 3 characters in length

  • have a total max of 100 characters in length

Create a blank book#

When you want to start from scratch, create a blank book.

  1. Go to My Books 1 and click Create a blank book 2.

    alt text

  2. Complete the dialogue.

    alt text

Actually speaking, the “blank” book still must contain a root document named index.md (Markdown)/index.rst (reStructuredText).

alt text

Create a book from a template#

Templates are a great way to start a new project — rather than starting with a blank page, you can start with dummy text, images, structure, and more.

See Create a book from a template for instructions.

Delete a book#

If you need it, you can always delete a book.

Caution

  • Please note that book deletion is permanent and immediate. After a deletion, the book cannot be restored.

  • When the book is published, it’s unpublished on deletion.

  1. In My Books, click three dots 1, and choose Delete 2.

    alt text

Change book settings#

Books offer a range of options that allow you to personalize their look, organization, and functionality. Certain options are defined when a book is created and remain fixed, while others can be modified and tailored at any time.

  1. Go to Book Settings 1, which is always the first “file” in file explorer.

    alt text

  2. Update the settings.

  3. When done, scroll down and click the Save button.

    alt text