# diataxis

> diataxis manages documentation as markdown pages typed by the Diátaxis framework and checks their structure and links.

Each link below opens a page's Markdown twin. Diátaxis sections are Tutorials, How-to guides, Reference, and Optional; Optional holds explanation pages and may be skipped. The command installs from the `diataxis` crate with `cargo install --locked diataxis`.


## Tutorials

- [Getting Started with diataxis](https://diataxis.eng.rip/getting-started.md): Set up a documentation set and write the first page

## How-to guides

- [How to adopt diataxis in an existing project](https://diataxis.eng.rip/how-to-adopt-diataxis-in-an-existing-project.md): Point a build script at the pages and drop the hand-written table

## Reference

- [diataxis CLI Reference](https://diataxis.eng.rip/cli-reference.md): Every command, argument, and option of the diataxis binary

## Optional

- [What is diataxis?](https://diataxis.eng.rip/what-is-diataxis.md): Why a documentation set carries types, and how the tool reads them