Amazing documentation tooling for Rust
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
examples
src
templates
tests
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Cargo.lock
Cargo.toml
Doxidize.toml
LICENSE-APACHE
LICENSE-MIT
README.md

README.md

Doxidize

Doxidize is a new tool for writing documentation for your Rust projects.

Status

We're still at a quite experimental phase here. Everything is subject to change at any time. Even the approach Doxidize takes is quite new, and different than Rust's current tooling.

What does that mean?

As a tool written in Rust, Doxidize is dogfooded. For more details, please check out the online documentation. If you would prefer to read them locally, do this:

> git clone https://github.com/steveklabnik/doxidize
> cd doxidize
> cargo run -- build
> cargo run -- serve

And then view the docs in your web browser.

Contributing to Doxidize

We'd love your help! To learn more about contributing to Doxidize, please check out CONTRIBUTING.md.

Two more things worth calling out here: this project abides by Rust's Code of Conduct (CODE_OF_CONDUCT.md), and is dual licensed under both the MIT (LICENSE-MIT) and Apache2 (LICENSE-APACHE) licenses. No CLA or copyright attribute is required, nor accepted.