forked from rust-lang/mdBook
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Much of the book was wrapped at around 80 columns, but let's make this consistent.
- Loading branch information
Showing
20 changed files
with
312 additions
and
234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,25 @@ | ||
# 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](http://www.rust-lang.org). | ||
**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](http://www.rust-lang.org). | ||
|
||
What you are reading serves as an example of the output of mdBook and at the same time as a high-level documentation. | ||
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](https://github.com/rust-lang-nursery/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/rust-lang-nursery/mdBook/issues). | ||
mdBook is free and open source, you can find the source code on | ||
[GitHub](https://github.com/rust-lang-nursery/mdBook). Issues and feature | ||
requests can be posted on the [GitHub issue | ||
tracker](https://github.com/rust-lang-nursery/mdBook/issues). | ||
|
||
## API docs | ||
|
||
Alongside this book you can also read the [API docs](https://docs.rs/mdbook/*/mdbook/) 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. | ||
Alongside this book you can also read the [API | ||
docs](https://docs.rs/mdbook/*/mdbook/) 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](https://www.mozilla.org/MPL/2.0/) | ||
mdBook, all the source code, is released under the [Mozilla Public License | ||
v2.0](https://www.mozilla.org/MPL/2.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.