Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Last synced: 2 months 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 1 year ago)
Default Branch: main
Last Pushed: 2024-06-18T18:51:10.000Z (7 months ago)
Last Synced: 2024-10-05T20:34:03.212Z (3 months ago)
Language: Rust
Size: 102 KB
Stars: 3
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`.