{"id":13571479,"url":"https://github.com/mkdocstrings/crystal","last_synced_at":"2025-04-07T18:15:03.659Z","repository":{"id":48692771,"uuid":"303816808","full_name":"mkdocstrings/crystal","owner":"mkdocstrings","description":"📘 Crystal language doc generator for https://github.com/mkdocstrings/mkdocstrings","archived":false,"fork":false,"pushed_at":"2025-02-15T16:34:01.000Z","size":229,"stargazers_count":30,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-31T16:14:57.166Z","etag":null,"topics":["crystal","handler","mkdocs","mkdocstrings"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/crystal","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"oprypin"}},"created_at":"2020-10-13T20:07:35.000Z","updated_at":"2025-02-20T02:59:23.000Z","dependencies_parsed_at":"2023-10-15T13:26:57.853Z","dependency_job_id":"7b41c518-c393-44bf-9672-8b533345188f","html_url":"https://github.com/mkdocstrings/crystal","commit_stats":{"total_commits":136,"total_committers":2,"mean_commits":68.0,"dds":0.007352941176470562,"last_synced_commit":"c3da4a046af57eaec9b8db008b260c3317b41fd8"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fcrystal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fcrystal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fcrystal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fcrystal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/crystal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247704571,"owners_count":20982298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crystal","handler","mkdocs","mkdocstrings"],"created_at":"2024-08-01T14:01:02.375Z","updated_at":"2025-04-07T18:15:03.639Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","funding_links":["https://github.com/sponsors/oprypin"],"categories":["Python"],"sub_categories":[],"readme":"# mkdocstrings-crystal\n\n**[Crystal][] language doc generator for [MkDocs][], via [mkdocstrings][]**\n\n[![PyPI](https://img.shields.io/pypi/v/mkdocstrings-crystal)](https://pypi.org/project/mkdocstrings-crystal/)\n[![License](https://img.shields.io/github/license/mkdocstrings/crystal)](https://github.com/mkdocstrings/crystal/blob/master/LICENSE.md)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mkdocstrings/crystal/ci.yml.svg)](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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fcrystal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fcrystal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fcrystal/lists"}