mdBook/README.md

987 B

mdBook

Personal implementation of Gitbook in Rust

This is a work in progress, it's far from being usable at the moment...

Progress

  • mdbook init creates boilerplate directory structure and files to start with.
    Could be tweaked a little bit for improvements, but it works
  • Parses SUMMARY.md and 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 html file for every entry in SUMMARY.md that 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