Glossary#
For better orientation and a quick overview, here is a list of the most important concepts and terms you will encounter in the Documatt and this documentation.
- book ID
A unique book identifier. We recommend using “yourname-bookname” format. When published, the book ID will be part of the web address. The book ID cannot be changed later.
- document
A text file written in Markdown or reStructuredText syntax. It has a
.mdor.rstfile extension, respectively.- root document
Special document that will be the first page readers see. You cannot rename, move, or delete it. A book must have exactly one root document. It is always called
index.md(Markdown)/index.rst(reStructuredText).- file
Any file in general. It could be a document or media (image).
- media
Image or video file. Not a document.
- Markdown
A lightweight markup language with plain text formatting syntax, designed to be easy to read and write, and commonly used for documentation.
- markup, syntax
A markup language is a system for annotating a document in a way that is syntactically distinguishable from the text. It defines the structure and presentation of raw text, allowing formatting, linking, and embedding of media. Examples include Markdown and reStructuredText.
- reStructuredText
A markup syntax for documentation, widely used in the technical and academic writing community.