-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This shows how to host docs with mdbook. Requires #11848 to not need a reshim
- Loading branch information
1 parent
1ebd4e5
commit bf5162f
Showing
2 changed files
with
67 additions
and
0 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
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 |
---|---|---|
@@ -0,0 +1,57 @@ | ||
mdBook | ||
====== | ||
|
||
.. meta:: | ||
:description lang=en: Learn how to host mdBook documentation on Read the Docs. | ||
|
||
`mdBook`_ is a command line tool to create books with Markdown. | ||
|
||
Minimal configuration is required to build an existing mdBook project on Read the Docs. | ||
|
||
.. code-block:: yaml | ||
:caption: .readthedocs.yaml | ||
version: 2 | ||
build: | ||
os: ubuntu-lts-latest | ||
tools: | ||
rust: latest | ||
commands: | ||
- cargo --version | ||
- cargo install mdbook | ||
# For an example book.. | ||
# - mdbook init docs | ||
- mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html | ||
.. _mdBook: https://rust-lang.github.io/mdBook/ | ||
|
||
Limitations | ||
----------- | ||
|
||
All Read the Docs features are supported for mdBook projects, | ||
as it builds static HTML files that can be hosted on Read the Docs. | ||
|
||
Getting started | ||
--------------- | ||
|
||
- If you have an existing mdBook project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide. | ||
- If you're new to mdBook, check out the official `Getting started with mdBook`_ guide. | ||
|
||
.. _Getting started with mdBook: https://rust-lang.github.io/mdBook/guide/creating.html | ||
|
||
Example repository and demo | ||
--------------------------- | ||
|
||
Example repository | ||
https://github.com/readthedocs/test-builds/tree/mdbook | ||
|
||
Demo | ||
https://test-builds.readthedocs.io/en/mdbook/ | ||
|
||
Further reading | ||
--------------- | ||
|
||
* `mdBook documentation`_ | ||
|
||
.. _mdBook documentation: https://rust-lang.github.io/mdBook/ |