Doctave

Doctave é uma plataforma de documentação que combina a flexibilidade de escrever em Markdown com o poder de hospedagem profissional de documentação. Você escreve sua documentação em arquivos de texto simples, os armazena no Git junto com seu código, e o Doctave se encarrega de transformá-los em belos sites de documentação pesquisáveis.

A plataforma suporta tanto guias em Markdown comuns quanto especificações OpenAPI para documentação de APIs. Ela cria automaticamente ambientes de pré-visualização quando você faz alterações, para que sua equipe possa revisar as atualizações antes da publicação. Tudo permanece no seu repositório Git, dando a você controle total de versão sobre sua documentação.

Doctave Studio é o aplicativo desktop complementar que oferece pré-visualizações em tempo real, sugestões de auto-completar, verificação de links quebrados e correção ortográfica. Juntas, essas ferramentas ajudam as equipes a criar documentação que se mantém atualizada e precisa.

Começar com o Doctave é simples. Veja como usá-lo de forma eficaz:

• Crie uma pasta de documentação no seu repositório de código e escreva seu conteúdo usando arquivos Markdown. Inclua um arquivo README.md como sua página inicial.

• Instale o Doctave Studio no seu computador para visualizar sua documentação localmente com atualizações em tempo real enquanto você escreve.

• Configure seu arquivo doctave.yml para definir a estrutura da documentação, as cores do tema e os links de navegação.

• Conecte seu repositório Git ao Doctave através da plataforma deles. Toda vez que você fizer push de alterações, o Doctave atualiza automaticamente sua documentação publicada.

• Para documentação de API, adicione seu arquivo de especificação OpenAPI ao seu repositório. O Doctave gerará automaticamente páginas de referência de API interativas.

• Use branches do Git para gerenciar diferentes versões da sua documentação. Crie pull requests para revisar as alterações antes de publicar, e o Doctave gerará links de visualização para cada pull request.

• Fluxo de trabalho de documentação baseado em Git com controle de versão

• Editor desktop Doctave Studio com visualização em tempo real

• Suporte à especificação OpenAPI para documentação de API

• Ambientes de visualização automáticos para pull requests

• Gerenciamento de documentação multi-versão

• Busca integrada em todo o conteúdo

• Opções personalizadas de marca e temas

• Análise de leitores e coleta de feedback

• Integração CI/CD para implantação automática

• Opções de documentação protegida por senha