Construtor open source de bases de conhecimento com LLM para documentação de produtos e técnica, FAQs e blogs, com escrita, perguntas e respostas e busca assistidas por IA.
10,5 mil+51 esta semana1 milTypeScriptAGPL-3.0Atualizado anteontem
star7th/showdoc
Ferramenta de documentação online e auto-hospedada para equipes de TI, com foco em documentação de APIs, dicionários de dados e wikis de equipe em Markdown.
Alternativa open source a:Confluence
Notion
- Estrelas
- 12,872
- Forks
- 2,212
- Issues abertas
- 235
- Último commit
- há 4 dias
O que é?
ShowDoc é uma ferramenta web para compartilhar documentos, criada para equipes de software. Ela resolve um problema comum: quando não há documentação atualizada, fica difícil para outras pessoas dar continuidade ao código escrito por alguém, e documentos espalhados em arquivos do Word e mensagens de chat ficam desatualizados rapidamente.
Os principais usos são a documentação de APIs, com a criação rápida de páginas de interface a partir de modelos; dicionários de dados, que descrevem campos do banco de dados; e documentos gerais de explicação ou especificação técnica. As páginas são escritas em Markdown, e cada uma mantém um histórico de versões que permite restaurar versões anteriores. Os projetos podem ser públicos ou privados, transferidos entre responsáveis e compartilhados com membros, além de exportados como documentos do Word para uso offline.
ShowDoc pode ser instalado no seu próprio servidor. A documentação do projeto inclui um guia de instalação e um guia de reforço de segurança para quem usa Nginx e Apache.
Recursos principais
- 01Modelos integrados para interfaces de API e dicionários de dados, que agilizam a criação de páginas.
- 02Editor Markdown com histórico de versões por página.
- 03Projetos públicos e privados, com gerenciamento de membros e transferência de propriedade.
- 04Layout responsivo para leitura no desktop e no celular.
- 05Exportação de projetos como documentos do Word para uso offline.
- 06Pode ser auto-hospedado no seu próprio servidor.
Casos de uso
- Documentar APIs de backend para que desenvolvedores de frontend e mobile possam consumi-las.
- Manter um dicionário de dados do banco que explique cada campo.
- Escrever instruções para ferramentas internas ou especificações técnicas para a equipe.
- Assumir a manutenção de um projeto legado sem documentação escrita.
Início rápido
- 1
Implante no seu próprio servidor seguindo o guia do AutoInstall
Antes de usar
- É necessário hospedar por conta própria. Se você usa Nginx ou Apache, deve negar o acesso ao diretório Sqlite/ por segurança.
- Os metadados listam a licença como NOASSERTION, e o README acrescenta termos de direitos autorais além do Apache 2.0 que exigem manter os avisos de copyright e os links na interface.
Em coleções
Tópicos
Perguntas frequentes
- O que é showdoc?
- Ferramenta de documentação online e auto-hospedada para equipes de TI, com foco em documentação de APIs, dicionários de dados e wikis de equipe em Markdown. ShowDoc é uma ferramenta web para compartilhar documentos, criada para equipes de software. Ela resolve um problema comum: quando não há documentação atualizada, fica difícil para outras pessoas dar continuidade ao código escrito por alguém, e documentos espalhados em arquivos do Word e mensagens de chat ficam desatualizados rapidamente.
- showdoc é gratuito? Qual é a licença?
- showdoc é open source sob a licença Other. Confira os termos da licença antes de usá-lo em produtos comerciais.
- showdoc ainda é mantido?
- Manutenção ativa. O último commit de showdoc foi em 3 de nov. de 2026.
- Para que posso usar showdoc?
- Documentar APIs de backend para que desenvolvedores de frontend e mobile possam consumi-las. Manter um dicionário de dados do banco que explique cada campo. Escrever instruções para ferramentas internas ou especificações técnicas para a equipe. Assumir a manutenção de um projeto legado sem documentação escrita.
- Como instalar showdoc?
- Implante no seu próprio servidor seguindo o guia do AutoInstall
- Onde consigo showdoc?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/star7th/showdoc
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Software open source de wiki colaborativa e documentação, que pode ser hospedado por conta própria como alternativa ao Confluence e ao Notion.
22,2 mil+79 esta semana1,7 milTypeScriptAGPL-3.0Bem mantidoAtualizado há 11 horas
Wiki auto-hospedada que roda como um único binário Go, com SQLite e arquivos Markdown em disco, sem precisar de banco de dados externo.
1,2 mil+13 esta semana102GoMITBem mantidoAtualizado há 13 horas
Um app gratuito e auto-hospedado para fazer anotações em rich text e Markdown, com listas de tarefas, diário e compartilhamento, como alternativa ao Notion e ao Obsidian.
995+22 esta semana49JavaScriptMITAtualizado há 11 horas
Wiki auto-hospedada, escrita em Go e sem banco de dados, que armazena todas as páginas como arquivos Markdown simples no disco.
62556GoGPL-3.0Bem mantidoAtualizado anteontem
Publique pastas, notas e documentação em Markdown como sites em segundos, usando arrastar e soltar, Obsidian, GitHub ou uma CLI para agentes de IA.
1,1 mil+2 esta semana120TypeScriptAGPL-3.0Bem mantidoAtualizado há 4 dias