actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mdBook/book-example/src
History
boxdot bf9f58e11b 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 18:57:47 +08:00
..
cli fix typo (#579) 2018-01-25 07:25:56 +08:00
for_developers Updated Cargo.toml metadata to make releases easier (#584) 2018-01-26 01:11:32 +08:00
format Add docs for mdBook specific include feature (#593) 2018-01-31 18:57:47 +08:00
misc Documenting the editor #521 2018-01-16 21:26:13 -08:00
README.md updated links from azerupi to rust-lang-nursery (#489) 2017-11-22 11:35:18 +01:00
SUMMARY.md Add docs for mdBook specific include feature (#593) 2018-01-31 18:57:47 +08:00

README.md

mdBook

mdBook is a command line tool and Rust crate to create books using Markdown files. It's very similar to Gitbook but written in Rust.

What you are reading serves as an example of the output of mdBook and at the same time as a high-level documentation.

mdBook is free and open source, you can find the source code on Github. Issues and feature requests can be posted on the Github Issue tracker.

API docs

Alongside this book you can also read the API docs generated by Rustdoc if you would like to use mdBook as a crate or write a new renderer and need a more low-level overview.

License

mdBook, all the source code, is released under the Mozilla Public License v2.0