Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Mathieu David da866db399 Create LICENSE 2015-07-29 01:11:30 +02:00
src Forgot to update level variable, fixed now. 2015-07-29 01:06:46 +02:00
.gitignore Started to implement init 2015-07-07 02:56:19 +02:00
Cargo.toml added markdown with 'pulldown-cmark', added basic styling, render of the toc is still not completely done 2015-07-28 21:01:13 +02:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
README.md update progress 2015-07-29 00:59:02 +02:00

README.md

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