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.
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.
1 maintainer
Release files for mkdocstrings-crystal 0.3.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocstrings_crystal-0.3.9.tar.gz | 18.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocstrings_crystal-0.3.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.0 kB
Release files / mkdocstrings_crystal-0.3.9.tar.gz
| Download URL | mkdocstrings_crystal-0.3.9.tar.gz |
|---|---|
| Size | 18.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d5c6887e7d50cb6a2c5b9e05533c95c4d51b2eebe270d1f72b4f18de3b891c92
|
|
BLAKE2b-256 checksum How to use checksums |
01542bd615f341cf5a29431183793f8163cfb1bc029a9ffde56a8ea25974a770
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2025.
Transparency logRelease files / mkdocstrings_crystal-0.3.9-py3-none-any.whl
| Download URL | mkdocstrings_crystal-0.3.9-py3-none-any.whl |
|---|---|
| Size | 21.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f16e66bc3af866a35c849187a01447c28da156ac116169ffc698127187ee344a
|
|
BLAKE2b-256 checksum How to use checksums |
8312add7ffb598fa48e676cf77982f26f4360e2ba18be1dcfb16079f592a05a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 8, 2025.
Transparency log
