mgeisler / SlimeVR-Docs-Site

SlimeVR site with docs and guides

SlimeVR Docs Site

https://docs.slimevr.dev

Contributions

By contributing to this project you are placing all your code under MIT or less restricting licenses, and you certify that the code you have used is compatible with those licenses or is authored by you. If you're doing so on your work time, you certify that your employer is okay with this.

Building

The docs use mdBook, Comprehensive Rust's i18nhelpers, and the mdbook-toc plugin. Install both tools with:

$ cargo install mdbook
$ cargo install --git https://github.com/google/comprehensive-rust.git i18n-helpers
$ cargo install mdbook-toc

Then run

$ mdbook serve -o

to start a web server with the docs. It will open a tab in your browser because of the -o flag