actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mdBook/guide/src/SUMMARY.md

33 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

Added an example book also containing the docs
2015-07-30 17:59:08 +08: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 17:59:08 +08: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 21:31:00 +08:00
- [watch](cli/watch.md)
Added option to configure serve interface and address browser will use to connect to websocket server.
2016-08-06 05:40:00 +08:00
- [serve](cli/serve.md)
fix mdbook test for the book
2015-12-30 06:59:08 +08: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 15:04:04 +08: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-06 02:36:21 +08:00
- [SUMMARY.md](format/summary.md)
Bring back draft chapters
2020-03-01 00:55:45 +08:00
- [Draft chapter]()
restructure guide configuration section restructure guide configuration section restructure guide configuration section redirect to new config top level fix broken links use a relative path for redirect Co-authored-by: Eric Huss <eric@huss.org> remove extra heading
2021-05-24 08:59:52 +08:00
- [Configuration](format/configuration/README.md)
- [General](format/configuration/general.md)
- [Preprocessors](format/configuration/preprocessors.md)
- [Renderers](format/configuration/renderers.md)
- [Environment Variables](format/configuration/environment-variables.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-06 02:36:21 +08:00
- [index.hbs](format/theme/index-hbs.md)
- [Syntax highlighting](format/theme/syntax-highlighting.md)
Documenting the editor #521
2018-01-17 13:26:13 +08:00
- [Editor](format/theme/editor.md)
Update documentation, Closes #80
2015-12-30 22:04:24 +08:00
- [MathJax Support](format/mathjax.md)
List supported Highlight.js languages in guide (#1345) * List supported Highlight.js languages in guide Generated using the technique described in https://github.com/rust-lang/mdBook/issues/1275#issuecomment-655903967. * Improve wording in guide
2020-09-30 07:56:31 +08:00
- [mdBook-specific features](format/mdbook.md)
user guide: Add instructions for running `mdbook` in CI This adds instructions for building and testing books in CI on every PR and push, as well as instructions for how to automatically deploy to gh-pages on successful CI runs on `master`. Fixes #714
2018-06-23 01:30:06 +08:00
- [Continuous Integration](continuous-integration.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)
Issue 703 (#929) * Replace all occurances of altenate backend with alternative backed Rename test for consistency of the terminology. * Use better sed command
2019-05-20 04:16:10 +08:00
- [Alternative 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-12 02:52:55 +08: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-12 02:52:55 +08:00
[Contributors](misc/contributors.md)