Converta um diretório de notas em um site HTML navegável e estilizado em um comando.
O alembic docs percorre o diretório fonte, converte cada arquivo Markdown encontrado e escreve um arquivo .html correspondente. Ele também constrói uma página índice que linka para cada página gerada, usando o primeiro título # como título da página.
Pense assim… uma fotocopiadora que pega folhas soltas e as encaderna em um livreto com sumário.
O conversor suporta títulos até quatro níveis, parágrafos, listas ordenadas e não ordenadas, blocos de código cercados com classes de linguagem, código inline, negrito, itálico e links. Ele escapa entidades HTML e envolve a saída em um documento HTML completo com uma folha de estilo responsiva clara/escura. A implementação está em packages/docs/src/markdown.ts e packages/docs/src/site.ts.
# uso básico alembic docs ./docs ./site # com título de site customizado alembic docs ./docs ./site --site-title "Docs do Projeto" # saída legível por máquina alembic docs ./docs ./site --json
O argumento --site-title é opcional e o padrão é "Documentation". A flag --json imprime {"pages": N, "indexPath": "..."} para que etapas de CI possam interpretar o resultado sem fazer scraping de texto. Subdiretórios são preservados: docs/api/core.md vira site/api/core.html.
Escreva um arquivo Markdown com um título, uma lista e um bloco de código cercado. Execute alembic docs e verifique se o HTML gerado preserva a estrutura e o estilo.