{"id":15017500,"url":"https://github.com/jakubandrysek/mkdoxy","last_synced_at":"2025-05-16T09:06:26.023Z","repository":{"id":46112458,"uuid":"390289971","full_name":"JakubAndrysek/MkDoxy","owner":"JakubAndrysek","description":"📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.","archived":false,"fork":false,"pushed_at":"2025-02-19T09:12:11.000Z","size":2344,"stargazers_count":101,"open_issues_count":24,"forks_count":23,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-16T09:06:19.499Z","etag":null,"topics":["code","code-snippets","documentation","documentation-generator","doxygen","mkdocs","mkdoxy","multilanguage","open-source","python","snippets"],"latest_commit_sha":null,"homepage":"https://mkdoxy.kubaandrysek.cz/","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/JakubAndrysek.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"zenodo":null},"funding":{"github":["JakubAndrysek"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2021-07-28T09:20:29.000Z","updated_at":"2025-05-15T02:41:16.000Z","dependencies_parsed_at":"2024-05-01T10:16:02.776Z","dependency_job_id":"b466dc07-b98a-40c3-8f54-7b40188bdcf3","html_url":"https://github.com/JakubAndrysek/MkDoxy","commit_stats":{"total_commits":171,"total_committers":16,"mean_commits":10.6875,"dds":0.2222222222222222,"last_synced_commit":"6be6e4173545402105a3f9805e6e7348ebe0ad0f"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2FMkDoxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2FMkDoxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2FMkDoxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2FMkDoxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JakubAndrysek","download_url":"https://codeload.github.com/JakubAndrysek/MkDoxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254501558,"owners_count":22081528,"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":["code","code-snippets","documentation","documentation-generator","doxygen","mkdocs","mkdoxy","multilanguage","open-source","python","snippets"],"created_at":"2024-09-24T19:50:34.324Z","updated_at":"2025-05-16T09:06:21.015Z","avatar_url":"https://github.com/JakubAndrysek.png","language":"Python","funding_links":["https://github.com/sponsors/JakubAndrysek","https://github.com/sponsors/jakubandrysek"],"categories":[],"sub_categories":[],"readme":"# MkDoxy\n\n**[MkDoxy](https://mkdoxy.kubaandrysek.cz/)** plugin for **[MkDocs](https://www.mkdocs.org/)** generates API documentation based on **[Doxygen](https://www.doxygen.nl)** comments and **[code snippets](/intro)** in your markdown files.\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://hits.seeyoufarm.com\"\u003e\u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2FMkDoxy\u0026count_bg=%2379C83D\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=hits\u0026edge_flat=true\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/license/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/releases\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/stargazers\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/forks\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/issues\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/MkDoxy/discussions\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/discussions/JakubAndrysek/MkDoxy?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.pepy.tech/projects/mkdoxy\" target=\"_blank\"\u003e\u003cimg src=\"https://static.pepy.tech/badge/mkdoxy\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003e **Warning**\n\u003e **Extension is in development**, and a few features are not working properly.\n\u003e More information in [Discussions](https://github.com/JakubAndrysek/MkDoxy/discussions) and [Issues](https://github.com/JakubAndrysek/MkDoxy/issues) pages.\n\n---\n\n## [:material-home-edit: Online Demo](https://jakubandrysek.github.io/MkDoxy-demo/) and [:simple-github: Demo source-code ](https://github.com/JakubAndrysek/MkDoxy-demo)\n\n---\n\n**[Feature List](#feature-list)** - **[Installation](#installation)** - **[Quick start](#quick-start)**\n\n## Feature List\n- **[Easy to use](#quick-start):**: Just add `mkdoxy` to your `mkdocs.yml` and configure the path to your source code.\n- **[Code snippets](./snippets/index.md)**: Generate code snippets in place of your standard Markdown documentation.\n- **[Multiple projects](./usage/index.md#multiple-projects)**: Support for multiple projects in one documentation (e.g. C++ and Python).\n- **[Multiple source directories](./usage/index.md#multiple-source-directories)**: Configure multiple source directories in one project.\n- **[Custom Jinja templates](./usage/index.md#custom-jinja-templates)**: Define custom Jinja templates for rendering Doxygen documentation.\n- **[Custom Doxygen configuration](./usage/index.md#custom-doxygen-configuration)**: Specify custom Doxygen configuration for each project.\n\n## Installation\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdoxy/):\n\n```bash\npip install mkdoxy\n```\nDevelopment version with all dependencies:\n```bash\npython -m pip install mkdoxy \".[dev]\"\n```\n\nInstall from source:\n```bash\npip install git+https://github.com/JakubAndrysek/MkDoxy.git\n```\n\n## Quick start\n\n`mkdocs.yml`:\n```yaml\nsite_name: \"My MkDoxy documentation\"\n\ntheme:\n  name: material\n\nplugins:\n  - search\n  - mkdoxy:\n      projects:\n        myProjectCpp: # name of project must be alphanumeric + numbers (without spaces)\n          src-dirs: path/to/src/project1 # path to source code (support multiple paths separated by space) =\u003e INPUT\n          full-doc: True # if you want to generate full documentation\n          doxy-cfg: # standard doxygen configuration (key: value)\n            FILE_PATTERNS: \"*.cpp *.h*\" # specify file patterns to filter out\n            RECURSIVE: True # recursive search in source directories\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you want to change.\n\n## Do You Enjoy MkDoxy or Does It Save You Time?\nThen definitely consider:\n\n- supporting me on GitHub Sponsors: [![](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86)](https://github.com/sponsors/jakubandrysek)\n\n## License\n\nThis project is licensed under the terms of the [MIT license](https://github.com/JakubAndrysek/MkDoxy/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdoxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakubandrysek%2Fmkdoxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdoxy/lists"}