{"id":13993851,"url":"https://github.com/omnilib/sphinx-mdinclude","last_synced_at":"2025-04-11T04:01:40.380Z","repository":{"id":43342571,"uuid":"455079983","full_name":"omnilib/sphinx-mdinclude","owner":"omnilib","description":"Markdown extension for Sphinx","archived":false,"fork":false,"pushed_at":"2024-05-16T22:31:34.000Z","size":320,"stargazers_count":17,"open_issues_count":7,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-17T17:37:21.196Z","etag":null,"topics":["documentation","hacktoberfest","markdown","sphinx","sphinx-extension","sphinx-plugin"],"latest_commit_sha":null,"homepage":"https://sphinx-mdinclude.omnilib.dev","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/omnilib.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2022-02-03T08:12:00.000Z","updated_at":"2024-06-18T12:24:36.355Z","dependencies_parsed_at":"2024-04-09T13:14:35.194Z","dependency_job_id":"475e7043-8ee0-4f37-90cf-9b924786a4e8","html_url":"https://github.com/omnilib/sphinx-mdinclude","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnilib%2Fsphinx-mdinclude","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnilib%2Fsphinx-mdinclude/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnilib%2Fsphinx-mdinclude/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnilib%2Fsphinx-mdinclude/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omnilib","download_url":"https://codeload.github.com/omnilib/sphinx-mdinclude/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248339256,"owners_count":21087214,"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":["documentation","hacktoberfest","markdown","sphinx","sphinx-extension","sphinx-plugin"],"created_at":"2024-08-09T14:02:35.523Z","updated_at":"2025-04-11T04:01:40.352Z","avatar_url":"https://github.com/omnilib.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"sphinx-mdinclude\n================\n\nSphinx extension for including or writing pages in Markdown format.\n\n[![version](https://img.shields.io/pypi/v/sphinx-mdinclude.svg)](https://pypi.python.org/pypi/sphinx-mdinclude)\n[![documentation](https://img.shields.io/badge/docs-latest-success)](https://sphinx-mdinclude.readthedocs.io)\n[![changelog](https://img.shields.io/badge/change-log-blue)](https://sphinx-mdinclude.omnilidb.dev/en/latest/changelog.html)\n[![license](https://img.shields.io/pypi/l/sphinx-mdinclude.svg)](https://github.com/omnilib/sphinx-mdinclude/blob/main/LICENSE)\n\n\nsphinx-mdinclude is a simple Sphinx extension that enables including Markdown documents\nfrom within reStructuredText. It provides the `.. mdinclude::` directive, and\nautomatically converts the content of Markdown documents to reStructuredText format.\n\nsphinx-mdinclude is a fork of [m2r](https://github.com/miyakogi/m2r) and\n[m2r2](https://github.com/crossnox/m2r2), focused only on providing a Sphinx extension.\n\n## Features\n\n* Basic markdown and some extensions (see below)\n    * inline/block-level raw html\n    * fenced-code block\n    * tables\n    * footnotes (``[^1]``)\n* Inline- and Block-level rst markups\n    * single- and multi-line directives (`.. directive::`)\n    * inline-roles (``:code:`print(1)` ...``)\n    * ref-link (``see `ref`_``)\n    * footnotes (``[#fn]_``)\n    * math extension inspired by [recommonmark](https://recommonmark.readthedocs.io/en/latest/index.html)\n* Sphinx extension\n    * add markdown support for sphinx\n    * ``mdinclude`` directive to include markdown from md or rst files\n    * option to parse relative links into ref and doc directives (``md_parse_relative_links``)\n\n## Restrictions\n\n* In the rst's directives, markdown is not available. Please write in rst.\n* Column alignment of tables is not supported. (rst does not support this feature)\n* Heading with overline-and-underline is not supported.\n  * Heading with underline is OK\n* Rst heading marks are currently hard-coded and unchangeable.\n  * H1: `=`, H2: `-`, H3: `^`, H4: `~`, H5: `\"`, H6: `#`\n\n## Installation\n\nPython 3.6 or newer is required.\n\n```\npip install sphinx-mdinclude\n```\n\n## Usage\n\nIn your Sphinx `conf.py`, add the following lines:\n\n```python\nextensions = [\n    ...,\n    'sphinx_mdinclude',\n]\n```\n\nMarkdown files with the `.md` extension will be loaded and used by Sphinx, similar to\nany other `.rst` files.\n\nTo include Markdown files within other files, use the `.. mdinclude:: \u003cfilename\u003e`\ndirective. This applies the conversion from Markdown to reStructuredText format.\n\n## License\n\n`sphinx-mdinclude` is copyright Hiroyuki Takagi, CrossNox, and [Amethyst Reese][],\nand licensed under the MIT license. I am providing code in this repository to you\nunder an open source license. This is my personal repository; the license you receive\nto my code is from me and not from my employer. See the [LICENSE][] file for details.\n\n[Amethyst Reese]: https://noswap.com\n[LICENSE]: https://github.com/omnilib/sphinx-mdinclude/blob/main/LICENSE\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnilib%2Fsphinx-mdinclude","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomnilib%2Fsphinx-mdinclude","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnilib%2Fsphinx-mdinclude/lists"}