https://github.com/rustic-rs/dev-docs
rustic dev documentation
https://github.com/rustic-rs/dev-docs
backup deduplication developer documentation encryption restic rust
Last synced: about 1 month ago
JSON representation
rustic dev documentation
- Host: GitHub
- URL: https://github.com/rustic-rs/dev-docs
- Owner: rustic-rs
- License: mpl-2.0
- Created: 2023-09-11T23:20:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T13:22:29.000Z (over 1 year ago)
- Last Synced: 2025-06-01T09:46:46.772Z (about 1 year ago)
- Topics: backup, deduplication, developer, documentation, encryption, restic, rust
- Language: Handlebars
- Homepage: http://rustic.cli.rs/dev-docs/
- Size: 393 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
developer Documentation
An open source developers documentation book for
[rustic](https://github.com/rustic-rs/rustic) that you can read
[here](https://rustic.cli.rs/dev-docs).
## Installation
This book is built with [mdbook](https://rust-lang.github.io/mdBook/). You can
install it by running `cargo install mdbook`.
### Additional dependencies
- `cargo install mdbook-last-changed` for date changes in the footer
- `cargo install mdbook-pandoc` for rendering the book to PDF
#### Texlive
```sh
# Source the .env file to get the PANDOC_VERSION
. ./.env
sudo apt-get update
sudo apt-get install -y texlive texlive-latex-extra texlive-luatex texlive-lang-cjk librsvg2-bin fonts-noto
curl -LsSf https://github.com/jgm/pandoc/releases/download/$PANDOC_VERSION/pandoc-$PANDOC_VERSION-linux-amd64.tar.gz | tar zxf -
```
## Building with mdbook
If you want to build it locally you can run one of these two commands in the
root directory of the repository:
- `mdbook build`
Builds static html pages as output and places them in the `/book` directory by
default.
- `mdbook serve`
Serves the book at `http://localhost:3000` (port is changeable, take a look at
the terminal output to be sure) and reloads the browser when a change occurs.
## License
The content of this repository is licensed under **MPL-2.0**; see
[LICENSE](./LICENSE).