1
0
mirror of https://github.com/ihabunek/toot synced 2024-12-22 23:08:17 +01:00
Toot-Mastodon-CLI-TUI-clien.../docs/documentation.md

39 lines
743 B
Markdown
Raw Normal View History

2023-03-03 17:12:59 +01:00
Documentation
=============
Documentation is generated using [mdBook](https://rust-lang.github.io/mdBook/).
Documentation is written in markdown and located in the `docs` directory.
Additional plugins:
- [mdbook-toc](https://github.com/badboy/mdbook-toc)
Install prerequisites
---------------------
You'll need a moderately recent version of Rust (1.60) at the time of writing.
Check out [mdbook installation docs](https://rust-lang.github.io/mdBook/guide/installation.html)
for details.
Install by building from source:
```
cargo install mdbook mdbook-toc
```
Generate
--------
HTML documentation is generated from sources by running:
```
mdbook build
```
To run a local server which will rebuild on change:
```
mdbook serve
```