SlimeVR Docs Site

Official SlimeVR Documentation: https://docs.slimevr.dev

The Documentation is created using mdBook with the following extensions:

• Comprehensive Rust's i18nhelpers
• mdbook-admonish plugin
• mdbook-toc plugin

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.

How To Use

1. Obtain Rust from the Rust Website Install Rust Page.

2. Obtain dependencies by running in repository root:

$ cargo setup

3. Launch local server by calling:

$ cargo start

or by calling:

$ cargo start-open

so it also opens browser when local server is started.

4. Once you finished making changes, verify internal links by running following command:

$ cargo check-links