From 91c29ef81e71c36dc9427fd9de431c034f48f295 Mon Sep 17 00:00:00 2001 From: Mathieu David Date: Sun, 19 Jul 2015 15:52:27 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eec0cb1c..c4cb2615 100644 --- a/README.md +++ b/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.
Could be tweaked a little bit for improvements, but it works +- [x] 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) +- [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
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](../../issues/1)