Skip to content

A WIP cargo extension for generating rustdoc in markdown especially for wikis like github wiki

License

Notifications You must be signed in to change notification settings

AS1100K/cargo-wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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. 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

Development Setup

$ cargo build
$ cp target/debug/cargo-wiki .
$ cargo wiki

Make sure to setup your path to the current directory

$ export PATH=/home/<user>/<path/to/cargo-wiki>:$PATH

About

A WIP cargo extension for generating rustdoc in markdown especially for wikis like github wiki

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages