https://github.com/as1100k/cargo-wiki
A WIP cargo extension for generating rustdoc in markdown especially for wikis like github wiki
https://github.com/as1100k/cargo-wiki
cargo cargo-wiki documentation-generator rust-markdown-docs rustdoc
Last synced: 3 months ago
JSON representation
A WIP cargo extension for generating rustdoc in markdown especially for wikis like github wiki
- Host: GitHub
- URL: https://github.com/as1100k/cargo-wiki
- Owner: AS1100K
- License: mit
- Created: 2024-12-23T05:40:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T15:35:47.000Z (over 1 year ago)
- Last Synced: 2025-02-13T15:36:43.222Z (over 1 year ago)
- Topics: cargo, cargo-wiki, documentation-generator, rust-markdown-docs, rustdoc
- Language: Rust
- Homepage: https://as1100k.github.io/cargo-wiki/
- Size: 85.9 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Cargo wiki
A WIP cargo extension for generating rust doc in markdown especially for wikis like github wiki.
## Demo
The repository generates it's documentation via `cargo wiki` using `single-file` structure and host it on github wiki
available [here](https://github.com/AS1100K/cargo-wiki/wiki). Note: This project is still in very early stage of
development and the generated output may contains issue and bug. If you find them, please open [issue here](https://github.com/AS1100K/cargo-wiki/issues)
## Development Setup
```bash
$ cargo build
$ cp target/debug/cargo-wiki .
$ cargo wiki
```
Make sure to setup your path to the current directory
```bash
$ export PATH=/home//:$PATH
```