Artisanal Rust inlined code documentation renderer
Here Screenshot / Action video
For this to work you need to have rust installed. You can do this with sudo pacman -S rustup, or any other package manager.
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] <FILE>...
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 <FILE> target file to render to, stdout if not given
-t, --title <String> The HTML title to render
ARGS:
<FILE>... rust source files
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
.
ToDo's towards 1.0
- [-] Improve Readme
- Make html mobile-friendly / responsive
- Remove remote includes from html
- Add
--title
-CLI parameter to add title - additional
--meta
,--header
and--footer
parameters to allow for easy customisation -
travis.yml
example to build on push -
build.rs
script-example to automagically build all examples of a crate - Integration and regression test suite
This is inspired by docco
by Bardadym Denis (sadly discontinued) and based off of the Rust tool dada
by Rui Vieira