Repolode
docsifyjs

docsifyjs/docsify

Um gerador de sites de documentação que transforma arquivos Markdown em um site sem exigir uma etapa de build.

Estrelas
31,556
Forks
5,784
Issues abertas
102
Último commit
há 7 horas

O que é?

O Docsify transforma um ou mais arquivos Markdown em um site de documentação sem gerar arquivos HTML estáticos durante o build. As páginas são renderizadas no navegador, então você pode escrever o conteúdo em Markdown, servir a pasta em qualquer servidor web estático ou no GitHub Pages e ver o site sem uma etapa de compilação.

O projeto é leve e oferece um plugin de busca em texto completo, vários temas integrados, suporte a emoji e uma API de plugins para estender o site. Também há um Docsify CLI separado, e a biblioteca pode ser carregada de CDNs comuns, como UNPKG, jsDelivr e cdnjs.

O Docsify é uma boa opção para documentações de projetos que precisam ficar no mesmo repositório que o código e ser atualizadas diretamente pela edição de arquivos Markdown.

Recursos principais

  • 01Renderiza arquivos Markdown em um site sem uma etapa de build
  • 02Funciona com qualquer servidor web estático ou com o GitHub Pages
  • 03Inclui um plugin de busca em texto completo
  • 04Oferece vários temas integrados
  • 05Disponibiliza uma API de plugins para personalização
  • 06Tem suporte a emoji

Casos de uso

  • Hospedar a documentação de um projeto junto com o código-fonte em um repositório Git
  • Publicar um site de documentação no GitHub Pages sem um pipeline de gerador de sites estáticos
  • Criar rapidamente uma base de conhecimento interna a partir de anotações Markdown existentes

Início rápido

  1. 1

    Use o Docsify Template pronto para usar no GitHub e publique-o com um servidor web estático ou o GitHub Pages

  2. 2

    Leia o tutorial de início rápido no site oficial da documentação

Tópicos

Perguntas frequentes

O que é docsify?
Um gerador de sites de documentação que transforma arquivos Markdown em um site sem exigir uma etapa de build. O Docsify transforma um ou mais arquivos Markdown em um site de documentação sem gerar arquivos HTML estáticos durante o build. As páginas são renderizadas no navegador, então você pode escrever o conteúdo em Markdown, servir a pasta em qualquer servidor web estático ou no GitHub Pages e ver o site sem uma etapa de compilação.
docsify é gratuito? Qual é a licença?
docsify é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
docsify ainda é mantido?
Manutenção ativa. O último commit de docsify foi em 21 de out. de 2026.
Para que posso usar docsify?
Hospedar a documentação de um projeto junto com o código-fonte em um repositório Git Publicar um site de documentação no GitHub Pages sem um pipeline de gerador de sites estáticos Criar rapidamente uma base de conhecimento interna a partir de anotações Markdown existentes
Como instalar docsify?
Use o Docsify Template pronto para usar no GitHub e publique-o com um servidor web estático ou o GitHub Pages Leia o tutorial de início rápido no site oficial da documentação
Onde consigo docsify?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/docsifyjs/docsify

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados