{"categories":[{"label":"Text Processing","url":"https://skillfed.io/packages/category/text-processing/2"}],"enrichment":{"capability":"Sphinx extension that lets you include and render Markdown files within reStructuredText documentation, converting Markdown to reStructuredText format on the fly.","skillfed_tags":["sphinx-extension","markdown-to-rst"],"use_cases":["Include a project's README.md directly in Sphinx docs without manually rewriting it in reStructuredText.","Mix Markdown and RST source files in the same Sphinx documentation build.","Embed Markdown-formatted content (tables, code blocks, footnotes) into RST pages via the mdinclude directive.","Maintain documentation in Markdown while using Sphinx as the build and hosting system.","Convert Markdown fragments to RST markup for inclusion in larger RST documents."],"what_it_does":"sphinx-mdinclude is a Sphinx extension that bridges Markdown and reStructuredText by providing an `mdinclude` directive to embed Markdown files into RST documentation. It converts Markdown syntax\u2014including tables, fenced code blocks, footnotes, and inline HTML\u2014into equivalent reStructuredText markup that Sphinx can render. The package is a focused fork focused only on providing a Sphinx extension.\n\nYou add it to your Sphinx `conf.py` extensions list, and then use the `.. mdinclude::` directive to pull in `.md` files alongside your existing `.rst` documentation. It also supports parsing relative links into Sphinx ref and doc directives. The conversion is automatic, so you write Markdown naturally and let the extension handle the translation.","worth_installing":"Yes, if you need to include Markdown files in a Sphinx documentation project. The extension is stable, has low install friction, carries no security vulnerabilities, and solves a real workflow problem\u2014mixing Markdown and RST sources. Maintenance is aging, so monitor the repository for any incompatibilities with future Sphinx versions."},"id":"sphinx-mdinclude","links":{"html":"https://skillfed.io/packages/sphinx-mdinclude","md":"https://skillfed.io/packages/sphinx-mdinclude.md","pypi":"https://pypi.org/project/sphinx-mdinclude/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2024-08-03","license_spdx":null,"license_treatment":"permissive","name":"sphinx_mdinclude","python_support":"supports_current","summary":"Markdown extension for Sphinx"},"popularity":{"monthly_downloads":494808,"position":6345,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.6.2"}