https://github.com/modprog/cargo-watchdoc

https://github.com/modprog/cargo-watchdoc

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/modprog/cargo-watchdoc
• Owner: ModProg
• License: apache-2.0
• Created: 2023-10-07T12:18:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-28T20:08:16.000Z (over 1 year ago)
• Last Synced: 2025-03-01T10:36:14.932Z (over 1 year ago)
• Language: Rust
• Size: 116 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# cargo watchdoc

[![CI Status](https://github.com/ModProg/cargo-watchdoc/actions/workflows/test.yaml/badge.svg)](https://github.com/ModProg/cargo-watchdoc/actions/workflows/test.yaml)

[![Crates.io](https://img.shields.io/crates/v/cargo-watchdoc)](https://crates.io/crates/cargo-watchdoc)

A CLI to live serve documentation for your crate while developing.

## Run

### General

Install via `cargo`: `cargo install cargo-watchdoc` and simply run as `cargo watchdoc` in your project.

### Nix

There's a `flake.nix` which also packaged `cargo-watchdoc`. You can simply run `nix run github:ModProg/cargo-watchdoc`.