Artisanal Rust inlined code documentation renderer (forked off from dada
by Rui Vieira; inspired by docco
)
Here Screenshot / Action video
You can install it quite easily with cargo install dadada
.
dadada
will be installed as command line tool for you to run. Just specify the files you want to have rendered and it will do so. If you do not provide a target output file (--output
/ -o
) the result will be printed to stdout.
The full list of cli arguments is: ``` Benjamin Kampmann ben@gnunicorn.org, Rui Vieira ruidevieira@googlemail.com Artisanal Rust inlined code documentation renderer
USAGE:
dadada [FLAGS] [OPTIONS]
FLAGS: -h, --help Prints help information --no-css Do not add CSS to output --no-js Do not add Javascript to output -V, --version Prints version information
OPTIONS:
-o, --output
ARGS:
An example to render all the rust files in your crate under target/dadada-output.html
therefor would be: dadada --title "All my Code Example" -o target/dadada-output.html src/*.rs
.
--title
-CLI parameter](https://github.com/gnunicorn/dadada/issues/3) to add title--meta
, --header
and --footer
parameters to allow for easy customisationtravis.yml
example](https://github.com/gnunicorn/dadada/issues/6) to build on pushbuild.rs
script-example](https://github.com/gnunicorn/dadada/issues/5) to automagically build all examples of a crate