{"id":15017515,"url":"https://github.com/rob-blackbourn/jetblack-markdown","last_synced_at":"2025-07-30T21:34:23.803Z","repository":{"id":62572331,"uuid":"231438925","full_name":"rob-blackbourn/jetblack-markdown","owner":"rob-blackbourn","description":"Markdown extensions for Python and mkdocs","archived":false,"fork":false,"pushed_at":"2023-12-19T18:33:11.000Z","size":2203,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-19T16:40:57.658Z","etag":null,"topics":["markdown","mkdocs","mkdocs-plugin","python"],"latest_commit_sha":null,"homepage":"https://rob-blackbourn.github.io/jetblack-markdown/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rob-blackbourn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2020-01-02T18:38:07.000Z","updated_at":"2024-12-10T06:23:00.000Z","dependencies_parsed_at":"2024-09-12T01:42:54.684Z","dependency_job_id":"71afc530-6141-41db-96b9-ec65e1c29647","html_url":"https://github.com/rob-blackbourn/jetblack-markdown","commit_stats":{"total_commits":92,"total_committers":3,"mean_commits":"30.666666666666668","dds":0.4347826086956522,"last_synced_commit":"8478e3e73c5506520749f33f0a1ffba6465f052b"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/rob-blackbourn/jetblack-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob-blackbourn%2Fjetblack-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob-blackbourn%2Fjetblack-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob-blackbourn%2Fjetblack-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob-blackbourn%2Fjetblack-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rob-blackbourn","download_url":"https://codeload.github.com/rob-blackbourn/jetblack-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob-blackbourn%2Fjetblack-markdown/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267945251,"owners_count":24170216,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdown","mkdocs","mkdocs-plugin","python"],"created_at":"2024-09-24T19:50:35.750Z","updated_at":"2025-07-30T21:34:23.772Z","avatar_url":"https://github.com/rob-blackbourn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jetblack-markdown\n\nMarkdown extensions for automatic document generation\n(read the [docs](https://rob-blackbourn.github.io/jetblack-markdown/)).\n\n## Autodoc Extension\n\nA markdown extension is provided for automatically documenting python code.\n\nModules are referred to as follows:\n\n```markdown\n# A Top Level Module\n\n@[jetblack_markdown]\n\n# A Package\n\n@[jetblack_markdown.autodoc]\n\n# A function\n\n@[jetblack_markdown.autodoc:makeExtension]\n\n# A class\n\n@[jetblack_markdown.autodoc.metadata:PropertyDescriptor]\n```\n\n### Customizing\n\nAll the rendering is done with jinja2 templates. Start by copying the current\ntemplates from jetblack_markdown/templates and specify the `template_folder` in\nthe `mkdocs.yml`.\n\n## LaTex2MathML Extension\n\nThere is a second extension which transforms LeTax style math formula\nto MathML HTML. Inline formula are surrounded by `$`, which blocks are\nfenced with `$$`. See the documentation for more details and examples.\n\n## mkdocs integration\n\nThis site was generated using `mkdocs` and the following config:\n\n```yaml\nsite_name: jetblack-markdown\n\ndocs_dir: documentation\nsite_dir: docs\n\nmarkdown_extensions:\n  - admonition\n  - codehilite\n  - jetblack_markdown.autodoc:\n      class_from_init: true\n      ignore_dunder: true\n      ignore_private: true\n      ignore_all: false\n      prefer_docstring: true\n      template_folder: null\n\nextra_css:\n    - css/custom.css\n```\n\n### Configuration\n\nThere are some configuration parameters for the autodoc extension.\n\n* class_from_init (bool, optional): If True use the docstring from\n    the \u0026#95;\u0026#95;init\u0026#95;\u0026#95; function for classes. Defaults to\n    True.\n* ignore_dunder (bool, optional): If True ignore\n    \u0026#95;\u0026#95;XXX\u0026#95;\u0026#95; functions. Defaults to True.\n* ignore_private (bool, optional): If True ignore methods\n    (those prefixed \u0026#95;XXX). Defaults to True.\n* ignore_all (bool): If True ignore the \u0026#95;\u0026#95;all\u0026#95;\u0026#95; member.\n* prefer_docstring (bool): If true prefer the docstring.\n* template_folder(Optional[str], optional): Specify a custom template folder.\n    The template \"main.jinja2\" will be rendered passing an `obj` parameter\n    which is a `jetblack.markdown.metadata.Descriptor`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frob-blackbourn%2Fjetblack-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frob-blackbourn%2Fjetblack-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frob-blackbourn%2Fjetblack-markdown/lists"}