mdengine Documentation¶
mdengine is a Python 3.10+ documentation and conversion engine. The PyPI distribution is named mdengine; all runtime code imports from md_generator under src/md_generator.
The repository is a modular monorepo. Each converter can be used as a command-line tool, many converters expose FastAPI services, and selected domains provide MCP servers for tool-based automation.
What This Site Covers¶
- Installation, local development, and operating guidance for Windows, macOS, and Linux.
- High-level and low-level architecture for the converter, API, MCP, database, graph, codeflow, log, and assistant modules.
- API endpoint families detected in the repository.
- Docker gateway deployment using
deploy/docker-compose.ymlanddeploy/nginx/default.conf. - Python reference pages generated with
mkdocstringsfrom themd_generatorpackage.
Detected Modules¶
pdf: PDF (md_generator.pdf), CLImd-pdf, extrapdf.word: Word (md_generator.word), CLImd-word, extraword.ppt: PowerPoint (md_generator.ppt), CLImd-ppt, extrappt.xlsx: Excel and CSV (md_generator.xlsx), CLImd-xlsx, extraxlsx.image: Image OCR (md_generator.image), CLImd-image, extraimage or image-ocr.text: Text JSON XML (md_generator.text), CLImd-text, extratext.archive: ZIP Archive (md_generator.archive), CLImd-zip, extraarchive plus nested format extras.url: URL and Web (md_generator.url), CLImd-url, extraurl or url-full.media-audio: Audio (md_generator.media.audio), CLImd-audio, extraaudio.media-video: Video (md_generator.media.video), CLImd-video, extravideo.media-youtube: YouTube (md_generator.media.youtube), CLImd-youtube, extrayoutube.playwright: Playwright Web Capture (md_generator.playwright), CLImd-playwright, extraplaywright.db: Database Metadata (md_generator.db), CLImd-db, extradb.graph: Graph Metadata (md_generator.graph), CLImd-graph, extragraph.openapi: OpenAPI (md_generator.openapi), CLImd-openapi, extraopenapi.codeflow: Codeflow (md_generator.codeflow), CLImd-codeflow or codeflow, extracodeflow.log: Log Analysis (md_generator.log), CLImd-log, extralog.tools-assistant: AI Assistant Tools (md_generator.tools.assistant), CLImdengine ai assist / mdengine ai export, extraskill-openai or skill-rag-chroma for optional providers.tools-skill-builder: Skill Builder (md_generator.tools.skill_builder), CLImdengine skill build, extrabase package.
Core Flow¶
flowchart LR
User[User] --> CLI[mdengine_and_md_CLIs]
User --> Gateway[Nginx_gateway]
Gateway --> FastAPI[FastAPI_services]
CLI --> Core[md_generator_core_modules]
FastAPI --> Core
Core --> Integrations[Files_databases_APIs_media_tools]
Core --> Output[Markdown_outputs]
Repository Source Of Truth¶
The root README.md, pyproject.toml, per-converter README files, codeflow-to-md/docs, and ai/ skill documentation remain authoritative sources for contributor-facing details. This MkDocs site organizes those facts into a deployable documentation platform.