Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-12 13:52:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Mathieu David 2015-07-19 15:52:27 +02:00
parent be0bfa7170
commit 91c29ef81e
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,6 +2,18 @@
Personal implementation of Gitbook in Rust
**Work in Progress...**
**This is a work in progress, it's far from being usable at the moment...**
To see what is already implemented and what has to be done next, check [this issue](../../issues/1)
### Progress
- [x] `mdbook init` creates boilerplate directory structure and files to start with. <br><sup>Could be tweaked a little bit for improvements, but it works</sup>
- [x] Parses `SUMMARY.md` and constructs a book data structure.<br><sup>Supports nested levels, empty links. Does not support other lines than list elements, does not suppport plain text. (Does not support = ignore)</sup>
- [x] Create JSon data from book
- [x] render handlebars template to html
- [x] create one `html` file for every entry in `SUMMARY.md` that is not an empty link<br><sup>Respecting original directory structure</sup>
- [ ] 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](../../issues/1)