Update README.md
This commit is contained in:
parent
be0bfa7170
commit
91c29ef81e
16
README.md
16
README.md
|
@ -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)
|
||||
|
|
Loading…
Reference in New Issue