https://github.com/srid/cargo-doc-live
Flake module to provide live server version of `cargo doc`
https://github.com/srid/cargo-doc-live
Last synced: about 1 year ago
JSON representation
Flake module to provide live server version of `cargo doc`
- Host: GitHub
- URL: https://github.com/srid/cargo-doc-live
- Owner: srid
- License: mit
- Created: 2023-08-13T01:14:16.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T20:37:50.000Z (almost 2 years ago)
- Last Synced: 2025-03-01T00:55:44.635Z (over 1 year ago)
- Language: Nix
- Size: 13.7 KB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cargo-doc-live
A [flake module](https://nixos.asia/en/flake-parts) to provide a live server version of `cargo doc` ― edit Rust code, and see the docs view in your web browser update automatically.
https://github.com/srid/cargo-doc-live/assets/3998/37378858-dda1-40fb-8f6a-f76dc857a661
## Getting Started
Full example: https://github.com/srid/rust-nix-template
Add the following flake inputs,
```nix
process-compose-flake.url = "github:Platonic-Systems/process-compose-flake";
cargo-doc-live.url = "github:srid/cargo-doc-live";
```
Import the relevant flake-parts modules,
```nix
imports = [
inputs.process-compose-flake.flakeModule
inputs.cargo-doc-live.flakeModule
];
```
Add the following to the `packages` of your devShell
```nix
packages = [
config.process-compose.cargo-doc-live.outputs.package
];
```
This will make the `cargo-doc-live` command available in your shell.