# mkdocstrings-crystal
**[Crystal][] language doc generator for [MkDocs][], via [mkdocstrings][]**
[](https://pypi.org/project/mkdocstrings-crystal/)
[](https://github.com/mkdocstrings/crystal/blob/master/LICENSE.md)
[](https://github.com/mkdocstrings/crystal/actions?query=event%3Apush+branch%3Amaster)
## 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][showcase].
To install it, run (possibly in a [virtualenv][]):
```shell
pip install mkdocstrings-crystal
```
**Continue to the [documentation site][].**
## Usage
With [MkDocs][], add/merge this base config as your _mkdocs.yml_:
```yaml
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 `:::`**:
```md
::: 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:
```shell
mkdocs build # generate from docs/ into site/
mkdocs serve # live preview
```
**Continue to the [documentation site][].**
[crystal]: https://crystal-lang.org/
[mkdocs]: https://www.mkdocs.org/
[mkdocstrings]: https://mkdocstrings.github.io/
[virtualenv]: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment
[documentation site]: https://mkdocstrings.github.io/crystal/
[showcase]: https://mkdocstrings.github.io/crystal/showcase.html
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocstrings-crystal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "crystal,mkdocs,mkdocs-plugin,mkdocstrings",
"author": "",
"author_email": "Oleh Prypin <oleh@pryp.in>",
"download_url": "https://files.pythonhosted.org/packages/d8/4b/e1a997348e6abe048f7a84b85c48b0e6bf501fc3f6c3e3a7dfc4ee9a4086/mkdocstrings_crystal-0.3.7.tar.gz",
"platform": null,
"description": "# mkdocstrings-crystal\n\n**[Crystal][] language doc generator for [MkDocs][], via [mkdocstrings][]**\n\n[](https://pypi.org/project/mkdocstrings-crystal/)\n[](https://github.com/mkdocstrings/crystal/blob/master/LICENSE.md)\n[](https://github.com/mkdocstrings/crystal/actions?query=event%3Apush+branch%3Amaster)\n\n## Introduction\n\n*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.\n\n[See it in action][showcase].\n\nTo install it, run (possibly in a [virtualenv][]):\n\n```shell\npip install mkdocstrings-crystal\n```\n\n**Continue to the [documentation site][].**\n\n## Usage\n\nWith [MkDocs][], add/merge this base config as your _mkdocs.yml_:\n\n```yaml\nsite_name: My Project\n\ntheme:\n name: material\n\nplugins:\n - search\n - mkdocstrings:\n default_handler: crystal\n\nmarkdown_extensions:\n - pymdownx.highlight\n - deduplicate-toc\n```\n\nThen, in any `docs/**/*.md` file, you can **mention a Crystal identifier alone on a line, after `:::`**:\n\n```md\n::: MyClass\n\n::: Other::Class#some_method\n\n::: Foo::CONSTANT\n```\n\n-- and in the output this will be replaced with generated API documentation for it, much like Crystal's own doc generator does.\n\nThis, of course, happens as part of a normal MkDocs build process:\n\n```shell\nmkdocs build # generate from docs/ into site/\nmkdocs serve # live preview\n```\n\n**Continue to the [documentation site][].**\n\n\n[crystal]: https://crystal-lang.org/\n[mkdocs]: https://www.mkdocs.org/\n[mkdocstrings]: https://mkdocstrings.github.io/\n[virtualenv]: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment\n[documentation site]: https://mkdocstrings.github.io/crystal/\n[showcase]: https://mkdocstrings.github.io/crystal/showcase.html\n",
"bugtrack_url": null,
"license": "",
"summary": "Crystal language doc generator for mkdocstrings",
"version": "0.3.7",
"project_urls": {
"Documentation": "https://mkdocstrings.github.io/crystal/",
"History": "https://github.com/mkdocstrings/crystal/releases",
"Issues": "https://github.com/mkdocstrings/crystal/issues",
"Source": "https://github.com/mkdocstrings/crystal"
},
"split_keywords": [
"crystal",
"mkdocs",
"mkdocs-plugin",
"mkdocstrings"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8063ae7f6d546d8e74fa4aee6d17d829cb8c600583c3ab5a1b0e1e3da5dda23a",
"md5": "d12b956aa9fcc1e73da02fe63a61804e",
"sha256": "91f25700a1e13ee5157aa5875441d333830c392d5ace7ef1c2106d9e5b2883b6"
},
"downloads": -1,
"filename": "mkdocstrings_crystal-0.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d12b956aa9fcc1e73da02fe63a61804e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20693,
"upload_time": "2023-10-25T17:40:05",
"upload_time_iso_8601": "2023-10-25T17:40:05.364717Z",
"url": "https://files.pythonhosted.org/packages/80/63/ae7f6d546d8e74fa4aee6d17d829cb8c600583c3ab5a1b0e1e3da5dda23a/mkdocstrings_crystal-0.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d84be1a997348e6abe048f7a84b85c48b0e6bf501fc3f6c3e3a7dfc4ee9a4086",
"md5": "9af0b7588f05e220f82b0b37ff1942ad",
"sha256": "6d0b2fc8ef1256aec2cc4ff22a7d5aff6398c574cede10a5941e5aa3590012c7"
},
"downloads": -1,
"filename": "mkdocstrings_crystal-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "9af0b7588f05e220f82b0b37ff1942ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16930,
"upload_time": "2023-10-25T17:40:07",
"upload_time_iso_8601": "2023-10-25T17:40:07.113669Z",
"url": "https://files.pythonhosted.org/packages/d8/4b/e1a997348e6abe048f7a84b85c48b0e6bf501fc3f6c3e3a7dfc4ee9a4086/mkdocstrings_crystal-0.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 17:40:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mkdocstrings",
"github_project": "crystal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocstrings-crystal"
}
JSON
