Module mdbook::book
[−]
[src]
The internal representation of a book and infrastructure for loading it from disk and building it.
For examples on using MDBook
, consult the top-level documentation.
Structs
Book |
A dumb tree structure representing a book. |
BookBuilder |
A helper for setting up a new book and its directory structure. |
BookItems |
A depth-first iterator over the items in a book. |
Chapter |
The representation of a "chapter", usually mapping to a single file on disk however it may contain multiple sub-chapters. |
Link |
A struct representing an entry in the |
MDBook |
The object used to manage and build a book. |
SectionNumber |
A section number like "1.2.3", basically just a newtype'd |
Summary |
The parsed |
Enums
BookItem |
Enum representing any type of item which can be added to a book. |
SummaryItem |
An item in |
Functions
load_book |
Load a book into memory from its |
parse_summary |
Parse the text from a |