mdx-include
Python Markdown extension to include local or remote files
Decision gist · record as of 2026-08-14
Yes, if you need file inclusion in Markdown and can tolerate dormant maintenance. The package is stable and has no known vulnerabilities, but it has not been updated since mid-2022. Install it for documentation tooling where you want to embed local or remote files, but do not expect active support or updates for new Markdown or Python versions.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low install friction with a pure Python wheel.
- Maintenance is dormant—last release was 2022-07-26 and no commits since 2024-03-16—so expect no active bug fixes or feature updates, though the package is marked Production/Stable.
License · maintenance · safety
BSD (permissive) — BSD license is permissive, allowing commercial and private use with minimal restrictions. You may use, modify, and distribute this package freely as long as you include the license notice.
last release 2022-07-26 (1480 days) · last repo commit 2024-03-16 · 63 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 128,762 downloads/mo, #11,695 on PyPI
Alternatives
Verify before relying
import markdown
text = r"{! file.md !}"
md = markdown.Markdown(extensions=['mdx_include'])
html = md.convert(text)- Whether Python 2 support (listed in classifiers) is actually maintained or tested given the dormant status since 2022.
- Current compatibility with recent versions of Markdown and its other dependencies (rcslice, cyclic).
What it is and what it does
mdx_include is a Markdown extension that lets you insert the contents of local files or remote URLs directly into your Markdown documents using a simple brace syntax like `{! file.md !}`. It handles recursive inclusion (files can include other files), file slicing by line and column ranges, content caching to avoid re-reading the same file multiple times, and circular inclusion detection. The extension depends on Markdown, rcslice for line/column slicing, and cyclic for circular dependency detection.
The package is motivated by an earlier markdown-include project but adds features like per-inclusion recursion control, indentation preservation, and configurable syntax delimiters. It's designed for documentation workflows where you want to keep content DRY by including shared snippets or examples from source files. Configuration options let you control recursion depth, encoding, caching behavior, and whether to allow local vs. remote includes.
Use it for
- Include code examples from source files into API documentation, keeping examples in sync with actual code.
- Build modular documentation by including shared sections (e.g., common setup steps) into multiple markdown files.
- Embed test fixtures or sample data files into markdown test reports or guides without manual copy-paste.
- Fetch and embed remote markdown or text files into a local document during build time.
- Slice and include only relevant portions of large files (e.g., a specific function from a source file) using line/column ranges.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need file inclusion in Markdown and can tolerate dormant maintenance.
The package is stable and has no known vulnerabilities, but it has not been updated since mid-2022. Install it for documentation tooling where you want to embed local or remote files, but do not expect active support or updates for new Markdown or Python versions.
Install
mdx-include on PyPI
Before you install
Low install friction with a pure Python wheel. Maintenance is dormant—last release was 2022-07-26 and no commits since 2024-03-16—so expect no active bug fixes or feature updates, though the package is marked Production/Stable.
License in practice
BSD license is permissive, allowing commercial and private use with minimal restrictions. You may use, modify, and distribute this package freely as long as you include the license notice.
Quickstart
import markdown
text = r"{! file.md !}"
md = markdown.Markdown(extensions=['mdx_include'])
html = md.convert(text)Verify before relying
- Whether Python 2 support (listed in classifiers) is actually maintained or tested given the dormant status since 2022.
- Current compatibility with recent versions of Markdown and its other dependencies (rcslice, cyclic).
Package facts
| License | BSD permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesMarkdownrcslicecyclic |
| Maintenance | Dormant 1,480 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 128,762 / month, #11,695 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersIntended Audience :: Information TechnologyLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 2Programming Language :: Python :: 3Topic :: Text Processing :: FiltersTopic :: Text Processing :: Markup |
Evidence: mdx_include-1.4.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “markdown file inclusion extension”
- mdx-includeA Markdown extension that embeds local or remote files into Markdown…
- markdown-includeAdds an include directive to Python-Markdown that lets you embed the…
- sphinx_mdincludeSphinx extension that lets you include and render Markdown files…
Give your agent the search over MCP, or paste the wish link into any chat.
More Markup packages
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
A Python markdown parser that converts markdown to HTML following the CommonMark specification, with support for plugins and custom syntax rules.
Install it if you need reliable markdown-to-HTML conversion.
Beautiful Soup parses HTML and XML documents into a navigable tree, providing Pythonic methods to search, iterate, and modify the parsed content.
Install it if you need to parse or extract data from markup documents.
et_xmlfile writes large XML files with minimal memory overhead by serializing elements to disk as they are created, rather than holding the entire tree in memory.
Install it if incremental XML writing fits your use case; skip it if your XML documents are small or you already use lxml.
Parses and edits TOML files while preserving formatting, comments, and structure, then serializes them back with layout intact.
Install it if you're building tools that touch TOML files and user readability of the source matters.
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
See also markdown-include · mkdocs-include-markdown-plugin · rcslice · markdownify · markitdown · sphinx_mdinclude · mkdocs-include-dir-to-nav · notion2md · Markdown · sphinx-markdown-tables