Skip to content

DavidVollmers/doki

Repository files navigation

doki

Doki is a .NET code documentation framework that allows you to generate documentation from your codebase.

It uses the XML documentation comments in your code to generate documentation in various formats, such as Markdown, JSON, and more.

Getting Started

Install the doki Command-Line Interface:

dotnet tool install --global Doki.CommandLine

Note: You can find the latest version of the CLI and how to install it on NuGet.

Set up your repository:

doki init

Generate documentation:

doki g

Documentation

Doki is documented using doki. You can find the generated API documentation here.

You can find the CLI documentation here.


License

This project is licensed under the MIT license.