2020-09-25 07:35:24 +01:00
|
|
|
# mdbook
|
|
|
|
|
|
2022-10-08 21:34:28 +01:00
|
|
|
> Create online books by writing Markdown files.
|
2020-09-25 07:35:24 +01:00
|
|
|
> More information: <https://rust-lang.github.io/mdBook/>.
|
|
|
|
|
|
2023-09-10 14:21:33 +01:00
|
|
|
- Create an mdbook project in the current directory:
|
2020-09-25 07:35:24 +01:00
|
|
|
|
|
|
|
|
`mdbook init`
|
|
|
|
|
|
2023-09-10 14:21:33 +01:00
|
|
|
- Create an mdbook project in a specific directory:
|
2020-09-25 07:35:24 +01:00
|
|
|
|
|
|
|
|
`mdbook init {{path/to/directory}}`
|
|
|
|
|
|
|
|
|
|
- Clean the directory with the generated book:
|
|
|
|
|
|
|
|
|
|
`mdbook clean`
|
|
|
|
|
|
2023-09-10 14:21:33 +01:00
|
|
|
- Serve a book at <http://localhost:3000>, auto build when file changes:
|
2020-09-25 07:35:24 +01:00
|
|
|
|
|
|
|
|
`mdbook serve`
|
|
|
|
|
|
2020-12-29 11:45:05 +00:00
|
|
|
- Watch a set of Markdown files and automatically build when a file is changed:
|
2020-09-25 07:35:24 +01:00
|
|
|
|
|
|
|
|
`mdbook watch`
|
