Documentação que os desenvolvedores realmente leem
A IA cria documentação com a estrutura que os desenvolvedores esperam — sumário na barra lateral, busca instantânea, seletor de versão e código fácil de copiar.
O que está incluído
Sumário na barra lateral
Navegação aninhada e retrátil sincronizada com a estrutura de arquivos da sua documentação.
Busca em texto completo
Busca em menos de 100 ms com tecnologia da Algolia ou índice nativo integrado.
Seletor de versão
Documentação com múltiplas versões (v1, v2, mais recente) com árvores de conteúdo por versão.
Blocos de código com cópia
Código com destaque de sintaxe em mais de 200 linguagens, com cópia em um clique e suporte a abas.
Para quem é
Documentação de API
APIs públicas que precisam de referência de endpoints, guias de autenticação e exemplos de código de SDK.
Projetos de código aberto
Projetos hospedados no GitHub com guias de configuração, uso e contribuição.
Bases de conhecimento internas
Manuais da empresa, documentos de integração e runbooks protegidos por SSO.
Casos de uso relacionados
Perguntas frequentes
Posso escrever documentação em Markdown?
Sim — suporte nativo a Markdown com frontmatter para título, descrição e posição na barra lateral.
A busca funciona offline?
A busca nativa integrada funciona sem dependências externas. Há upgrade para a Algolia disponível para maior tráfego.
Posso hospedar várias versões?
Sim — cada versão é uma árvore de conteúdo separada; os usuários alternam pelo menu suspenso da barra superior.
Existe modo escuro?
Sim — sincroniza automaticamente com a preferência do sistema do usuário; há substituição manual disponível.
Posso publicar páginas de referência de API com exemplos de código?
Sim — os modelos de documentação suportam tabelas de parâmetros, exemplos de resposta e trechos de código em abas para vários SDKs.

