{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Enables Sphinx and Docutils projects to parse and render CommonMark (Markdown) files alongside reStructuredText, bridging CommonMark syntax to the Docutils document model.","skillfed_tags":["deprecated","markdown-to-rst"],"use_cases":["Adding Markdown documentation files to an existing Sphinx project without rewriting everything in reStructuredText.","Using AutoStructify to automatically generate table-of-contents and cross-reference structures from Markdown headings during the Sphinx build.","Migrating documentation from a Markdown-based system to Sphinx while keeping Markdown as the source format during transition.","Enabling teams familiar with Markdown to contribute to Sphinx-based documentation without learning reStructuredText syntax."],"what_it_does":"recommonmark is a parser that lets Sphinx and Docutils projects write documentation in CommonMark (Markdown) instead of only reStructuredText. It acts as a bridge between the CommonMark syntax and Docutils' internal document model, allowing you to mix .md and .rst files in the same project and use Sphinx features like cross-references and auto-generated table of contents from Markdown headings.\n\nThe package includes AutoStructify, an optional component that can automatically transform Markdown into reStructuredText at build time, with support for features like automatic table-of-contents generation, math formulas, and embedded reStructuredText evaluation. However, the project is now deprecated and archived; its maintainers recommend using an alternative for new work.","worth_installing":"No. The package is abandoned (last commit 2021-05-18) and its maintainers explicitly recommend an alternative. While it has low install friction and no known vulnerabilities, the lack of ongoing maintenance means no compatibility fixes for current Sphinx versions and no security updates."},"id":"recommonmark","links":{"html":"https://skillfed.io/packages/recommonmark","md":"https://skillfed.io/packages/recommonmark.md","pypi":"https://pypi.org/project/recommonmark/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2020-12-17","license_spdx":null,"license_treatment":"permissive","name":"recommonmark","python_support":"unspecified","summary":"A docutils-compatibility bridge to CommonMark, enabling you to write CommonMark inside of Docutils & Sphinx projects."},"popularity":{"monthly_downloads":1181183,"position":4257,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"0.7.1"}