jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mdbook/book-example/src/SUMMARY.md

27 lines
840 B
Markdown
Raw Normal View History

Added an example book also containing the docs
2015-07-30 11:59:08 +02:00
# Summary
- [mdBook](README.md)
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
- [Command Line Tool](cli/README.md)
Added an example book also containing the docs
2015-07-30 11:59:08 +02:00
- [init](cli/init.md)
- [build](cli/build.md)
Watch builds are now spawned in new threads (using crossbeam) and there is a timelock, preventing multiple builds being triggered in less than a second
2015-11-09 14:31:00 +01:00
- [watch](cli/watch.md)
Added option to configure serve interface and address browser will use to connect to websocket server.
2016-08-05 21:40:00 +00:00
- [serve](cli/serve.md)
fix mdbook test for the book
2015-12-29 17:59:08 -05:00
- [test](cli/test.md)
Update documentation to reflect addition of `clean` subcommand. (#607) * update documentation Update README.md and User Guide to reflect addition of `clean` subcommand. Do minor spelling fixes too. * fix grammar in `clean` documentation
2018-02-18 10:04:04 +03:00
- [clean](cli/clean.md)
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
- [Format](format/README.md)
Added some chapters for the documentation #30 + tweaked the syntax highlighting theme
2015-08-05 20:36:21 +02:00
- [SUMMARY.md](format/summary.md)
Added author and dest field in book.json, fixed bug when output directory did not exist. Closes #7
2015-08-03 14:23:32 +02:00
- [Configuration](format/config.md)
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
- [Theme](format/theme/README.md)
Added some chapters for the documentation #30 + tweaked the syntax highlighting theme
2015-08-05 20:36:21 +02:00
- [index.hbs](format/theme/index-hbs.md)
- [Syntax highlighting](format/theme/syntax-highlighting.md)
Documenting the editor #521
2018-01-16 21:26:13 -08:00
- [Editor](format/theme/editor.md)
Update documentation, Closes #80
2015-12-30 15:04:24 +01:00
- [MathJax Support](format/mathjax.md)
Add docs for mdBook specific include feature (#593) * Add docs for mdBook specific include feature. Also: * Fix bug in take_lines taking `end`-many lines instead of `end-start` many. * Handle special case `include:number` as including a single line. * Start counting lines at 1 and not 0. * Merge mdBook and rust specific features into one chapter.
2018-01-31 11:57:47 +01:00
- [mdBook specific features](format/mdbook.md)
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
- [For Developers](for_developers/README.md)
Increase Documentation Coverage (#543) * Added documentation to the `config` module * Added an example to the `config` module * Updated the docs in lib.rs regarding implementing backends * Started writing an alternate backends walkthrough * Mentioned the output.foo.command key * Added example output * Added a config section to the backends tutorial * Finished off the backends tutorial * Made sure travis checks mdbook-wordcount * Fixed the broken link at in the user guide * Changed how travis builds the project * Added a conclusion * Went through and documented a lot of stuff * Added a preprocessors chapter and updated For Developers
2018-01-21 22:35:11 +08:00
- [Preprocessors](for_developers/preprocessors.md)
- [Alternate Backends](for_developers/backends.md)
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9
2015-09-11 20:52:55 +02:00
-----------
Add index preprocessor (#685) * Add index preprocessor README.md is a de facto index file in markdown-based documentation. Hence, we respect to README.md and convert it into index.html. * Fix warning for unused variables * Update tests for config * Match file stem case-insensitively for IndexPreprocessor * Add tests for IndexPreprocessor * Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9
2015-09-11 20:52:55 +02:00
[Contributors](misc/contributors.md)
Reference in a new issue Copy permalink