mkdocstrings-zig

A Zig handler for mkdocstrings. Makes it possible to create documentation from code in Zig language using mkdocs.

Demo

See demo documentation generated from test_zig_project.

Usage

Installation

pip install 'mkdocstrings[zig]'
pip install mkdocs-material
pip install typing-extensions

mkdocs-material theme installation is optional, but recommended for better look and feel.

mkdocs.yml example

site_name: Example of zig project documentation using mkdocstrings

# remove if you are not using mkdocs-material theme
# or replace it with the theme of your choice
theme:
  name: material

plugins:
- mkdocstrings:
    default_handler: zig

docs/index.md example

# Project Documentation

::: src/main.zig

::: src/root.zig

In the future it's planned to add a possibility to specify just a parent directory, like that:

::: src