md-to-doc
Skill0 starsChanged 2 months agoMITView on GitHub
Renderiza cualquier árbol de Markdown (docs/, ADRs, runbooks, notas, specs) a un documento HTML autocontenido con portada e índice — y opcionalmente a PDF. El núcleo funciona con Python stdlib y embebe cada imagen como data URI, así que el resultado es UN solo fichero que se puede mover o adjuntar sin arrastrar carpetas de assets. Capas opt-in que degradan con aviso si falta la herramienta — `images` (Pillow, optimiza y convierte a gris en perfil de impresión), `highlight` (pygments), `diagrams` (mmdc, convierte fences mermaid a PNG con caché por hash, los diagramas que GitHub renderiza pero un PDF no), `exec` (ejecuta bloques marcados y captura su salida REAL en vez de una inventada), `pdf` (xhtml2pdf). Úsalo cuando el usuario diga "genera un PDF de la documentación", "exporta los docs a HTML", "compila el manual", "un solo fichero con toda la doc", "los diagramas no salen en el PDF", o "documentación offline". Trabaja sobre `Path.cwd()` — funciona en cualquier repo.
- Installs packages
1 other project uses a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- vladimiracunadev-create/claude-skills-toolkitedited, first seen Nov 1, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 1
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository19 other files it gives its agents.
- bitcoin-custody-auditSkill
- docker-cleanupSkill
- docker-compose-doctorSkill
- functional-user-flow-testerSkill
- md-lint-fixSkill
- pre-commit-guardSkill
- preliminary-product-testerSkill
- pre-push-guardSkill
- python-deps-pinningSkill
- python-lint-guardSkill
- python-version-controlSkill
- release-evidence-auditorSkill
- repo-coherence-auditSkill
- security-auditSkill
- software-resilience-state-testerSkill
- nombre-del-skillSkill
- version-bumpSkill
- web-snapSkill
- yaml-controlSkill
The file
Files
md-to-doc
Convierte una colección de ficheros Markdown en un documento: HTML autocontenido, o PDF.
Por qué existe
Todo repo con documentación seria acaba necesitando lo mismo — juntar los .md
en algo que se pueda leer de corrido, imprimir o adjuntar. Y casi siempre se
resuelve con un script ad-hoc que solo sirve para ese repo.
Los dos fallos que este skill ataca:
- Documentos que no son autocontenidos. Un HTML que referencia
./img/diagrama.pngdeja de funcionar en cuanto se mueve. Aquí las imágenes van embebidas como data URI: el fichero viaja solo. - Diagramas que desaparecen. GitHub renderiza los fences
```mermaidde forma nativa, así que se escriben sin pensar. Al exportar a PDF no renderiza nadie: el diagrama sale como un bloque de texto plano o no sale. La capadiagramslos convierte a imagen antes de componer.
Cuándo invocar este skill
Triggers explícitos:
- "genera un PDF de la documentación"
- "exporta los docs a HTML"
- "compila el manual"
- "quiero un solo fichero con toda la doc"
- "los diagramas no salen en el PDF"
- "documentación offline"
- "export docs to PDF"
Triggers proactivos:
- Al preparar una entrega o release que incluya documentación
- Cuando el usuario necesita revisar los docs sin acceso al repo
Cómo se invoca
# Núcleo: cero dependencias
python ~/.agents/skills/md-to-doc/md_to_doc.py --src docs --out manual.html
# Con diagramas y resaltado
python ~/.agents/skills/md-to-doc/md_to_doc.py --src docs --layer diagrams --layer highlight
# Listo para imprimir
python ~/.agents/skills/md-to-doc/md_to_doc.py --src docs --profile print \
--layer images --layer diagrams --layer pdf --out manual.pdf| Flag | Efecto |
--src DIR | Directorio con los .md (por defecto: cwd) |
--out FICHERO | Salida .html o .pdf |
--title / --subtitle | Portada |
--profile color|print | print: paleta monocroma + imágenes en gris |
--layer NOMBRE | Capa opcional, repetible |
--order FICHERO | Orden explícito, un path por línea |
--cache DIR | Caché de diagramas renderizados |
--exec-timeout N | Segundos máximos por bloque ejecutado (default 10) |
Arquitectura por capas
El núcleo nunca depende de nada externo. Cada capa se pide explícitamente y, si su herramienta no está, el documento se genera igual con un aviso en la sección "Avisos de generación" del propio documento.
| Capa | Herramienta | Qué añade | Si falta |
| (núcleo) | stdlib | Parseo Markdown, portada, índice, imágenes como data URI | — |
images | pillow | Reescala y optimiza; convierte a gris en perfil print | Imágenes sin optimizar |
highlight | pygments | Resaltado de sintaxis | Código sin colorear |
diagrams | mmdc | Fences ```mermaid → PNG, cacheado por hash del diagrama | Quedan como texto |
exec | — | Ejecuta bloques ```lang run y captura su salida real | Capa inactiva |
pdf | xhtml2pdf | HTML → PDF | Se emite solo HTML |
Orden de los documentos
- El fichero de
--order, si se pasa. SUMMARY.mden el directorio origen (convención mdBook/GitBook).- Prefijo numérico (
01-,02-…) y después alfabético.
La capa diagrams y su caché
Los diagramas se cachean por sha256 de su contenido. Un diagrama que no
cambió entre dos ejecuciones no se vuelve a renderizar — que importa cuando
mmdc arranca un Chromium por invocación.
La capa exec
Solo ejecuta bloques marcados explícitamente:
```python run
print(sum(range(1, 11)))
```La salida capturada se inserta debajo del código como bloque de consola. El valor es que la documentación muestra lo que el código hace de verdad, no lo que alguien recordaba que hacía cuando lo escribió.
⚠️ Ejecuta código del Markdown de origen. Está detrás de
--layer exec, avisa porstderral arrancar, corre conpython -I(aislado dePYTHONPATHy delsitedel usuario) y con timeout. Aun así: úsala solo sobre fuentes en las que confías. Por defecto está desactivada.
Qué NO hace / limitaciones
- No es un renderizador CommonMark completo. Cubre encabezados, párrafos, énfasis, código inline y en bloque, listas, tablas, citas, reglas, enlaces e imágenes. No cubre listas anidadas de varios niveles, notas al pie, definiciones ni HTML crudo embebido.
- No descarga imágenes remotas. Una
se deja como enlace: el documento deja de ser autocontenido en ese punto y así se reporta. - Solo ejecuta Python en la capa
exec. Otros lenguajes se ignoran con aviso. - El PDF hereda los límites de
xhtml2pdf: soporte CSS parcial y fuentes del sistema. Para tipografía compleja o emoji, revisa el resultado. - No modifica los
.mdde origen. Solo lee.
Dependencias
| Dependencia | Cómo instalar | Requerida u opcional |
python>=3.11 | viene con el SO | requerida |
pillow | pip install pillow | opcional — capa images |
pygments | pip install pygments | opcional — capa highlight |
@mermaid-js/mermaid-cli | pnpm add -g @mermaid-js/mermaid-cli | opcional — capa diagrams |
xhtml2pdf | pip install xhtml2pdf | opcional — capa pdf |
Ver docs/supply-chain-security.md sobre
por qué pnpm en lugar de npm.
Ejemplo de salida
✓ HTML autocontenido generado: /repo/manual.html
documentos procesados: 40
perfil: color · capas: diagrams, highlight
⚠ imagen no encontrada: ./img/archivo.png (desde web-snap)Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

