Dokio is a Wiki for agile software and architecture documentation that lives in your source code repository and is super easy to use. Why not version control your documentation along with your software and keep it in sync with Dokio's advanced features that enable living documentation and automatic drift checks.
It's Markdown powered by pulldown-cmark
You can use the full Markdown syntax as defined by the CommonMark standard to write your documentation. Including images, hyperlinks and if that's not enough, you can always fall back on plain html.
It's diagrams as code powered by nomnoml
[nomnoml] is -> [awesome]
Dokio is written in Rust. That's why it's super fast and works right out of the box. No installing insert language runtime you hate or insert package manger you hate. It's just a small binary, you can check into your SCM. That's all.
Because Dokio lives in your SCM, all you documentation is version controlled and in sync with your source code version. And since Dokio treats your diagrams as code as well, changes are easy and don't require specialised tools and the original format that created the image files.
Dokio uses Twitter Bootstrap for nice typography and beautiful CSS components.
Don't like the above theme? Write your own! It's easy.
One of the next big features will be the ability to link your source code and documentation, so that they never go out of date again.
You can grab the latest version here
Dokio is documented using Dokio. Run it with cargo run in order to get the best out if this documentation:
doc/index.md
Dokio is configured using a Dokiofile at the root of your Repository.
Here's an example Dokiofile:
port = 4000; // default is 3000
default_page = "usage.md"; // default is README.md
theme = "my_company_theme"; // default is dokio