mirror of
https://github.com/rust-lang/mdBook.git
synced 2025-12-27 09:05:40 -05:00
91c29ef81e71c36dc9427fd9de431c034f48f295
mdBook
Personal implementation of Gitbook in Rust
This is a work in progress, it's far from being usable at the moment...
Progress
mdbook initcreates boilerplate directory structure and files to start with.
Could be tweaked a little bit for improvements, but it works- Parses
SUMMARY.mdand constructs a book data structure.
Supports nested levels, empty links. Does not support other lines than list elements, does not suppport plain text. (Does not support = ignore) - Create JSon data from book
- render handlebars template to html
- create one
htmlfile for every entry inSUMMARY.mdthat is not an empty link
Respecting original directory structure - page layout
- show content on page rendered from markdown
- construct sidebar table of contents
- support config file
For more information about progress and what is still on my to-do list, check this issue
Languages
Rust
75.7%
JavaScript
7.6%
CSS
6.5%
Handlebars
5.5%
HTML
4%
Other
0.7%