Project Links

Meta

Author: Oleh Prypin

Requires Python: >=3.9

Classifiers

Development Status

4 - Beta

Environment

Console
Web Environment

Intended Audience

Developers

License

OSI Approved :: MIT License

Operating System

OS Independent

Programming Language

Python
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12
Python :: 3.13

Topic

Documentation
Software Development :: Documentation
Text Processing :: Markup :: Markdown

Typing

Typed

mkdocstrings-crystal

Crystal language doc generator for MkDocs, via mkdocstrings

Introduction

mkdocstrings-crystal allows you to insert API documentation (generated from Crystal's source code and doc comments) as part of any page on a MkDocs site.

See it in action.

To install it, run (possibly in a virtualenv):

pip install mkdocstrings-crystal

Continue to the documentation site.

Usage

With MkDocs, add/merge this base config as your mkdocs.yml:

site_name: My Project

theme:
  name: material

plugins:
  - search
  - mkdocstrings:
      default_handler: crystal

markdown_extensions:
  - pymdownx.highlight
  - deduplicate-toc

Then, in any docs/**/*.md file, you can mention a Crystal identifier alone on a line, after ::::

::: MyClass

::: Other::Class#some_method

::: Foo::CONSTANT

-- and in the output this will be replaced with generated API documentation for it, much like Crystal's own doc generator does.

This, of course, happens as part of a normal MkDocs build process:

mkdocs build  # generate from docs/ into site/
mkdocs serve  # live preview

Continue to the documentation site.

Wheel compatibility matrix

Platform	Python 3
any

Files in release

mkdocstrings_crystal-0.3.9-py3-none-any.whl (20.5KiB)

mkdocstrings_crystal-0.3.9.tar.gz (17.6KiB)

Extras: None

Dependencies:

jinja2 (>=2.11.2)

markdown-callouts (>=0.1.0)

markupsafe (>=1.1.1)

mkdocs-autorefs (>=0.3.1)

mkdocstrings (>=0.30.0)

mkdocstrings-crystal 0.3.9