Step 01 · Alembic Toolkit · Alembic Toolkit · O que fazem Docs e Doctor do Alembic ENPT
Alembic · Visual Course

O que fazem Docs e Doctor do Alembic

Dois novos comandos de CLI que transformam Markdown em site e verificam seu ambiente local.

Read the plain version, or open the technical layer on any section.
1

A ideia central


O alembic docs lê uma pasta de arquivos Markdown e escreve um pequeno site HTML estilizado. Você aponta para um diretório de notas, READMEs ou páginas wiki; ele produz um index.html mais uma página HTML por arquivo fonte.

O alembic doctor verifica o ambiente local: Node, pnpm, git, o CLI Higgsfield, o diretório de dados e o gateway LLM local. Ele reporta OK / WARN / FAIL para que você saiba se o próximo comando vai funcionar.

Pense assim… uma mesa de publicação (docs) e uma checklist de pré-voo (doctor) para o motor Alembic.

Under the hood

Ambos os comandos são implementados no pacote apps/cli e ligados pelo mesmo parser de argumentos do resto da CLI. O docs delega a conversão ao novo pacote @alembic/docs, que mantém o parser Markdown independente e testável. O doctor sonda binários externos com which e --version, e sonda via HTTP o gateway cliproxyapi quando não está em modo offline.

2

In one picture


Markdown folderHTML sitedoctornode ✓pnpm ✓git ✓gateway ✓
Markdown entra, site sai; doctor verifica a pista antes da decolagem.
3

In the code


O comando docs precisa de dois argumentos posicionais: diretório fonte e diretório de saída. O comando doctor não precisa de nenhum.

# transforma notes/ em site estático em site/
alembic docs notes site --site-title "My Docs"

# verifica o ambiente
alembic doctor

Implementation notes

generateSite() em @alembic/docs coleta recursivamente arquivos .md e .markdown, converte cada um com um pequeno parser customizado (títulos, parágrafos, listas, blocos de código, formatação inline, links) e envolve o corpo em um documento HTML autocontido com CSS claro/escuro. runDoctor() em apps/cli retorna um relatório tipado de verificações; a CLI o renderiza como texto ou JSON.

4

Try it


Crie uma pasta com dois arquivos Markdown e execute alembic docs minhas-notas meu-site. Depois abra meu-site/index.html no navegador.

Execute alembic doctor --json e inspect os checks reportados.

Pergunte-se: Quais das suas pastas Markdown existentes se beneficiariam de um site estático rápido? Qual check do doctor é mais provável de falhar em uma máquina nova?