Gerar documentação com arquivos Markdown usando o Docsify

Se você estiver criando um plug-in gratuito, estrutura ou script de código aberto você precisará de documentação. É crucial documentar seu trabalho, tanto para a sua sanidade como para ajudar os outros que querem aprender o seu fantástico recurso.

No entanto, criar documentação on-line pode ser uma verdadeira dor. agradecidamente, Docsify torna mais fácil, fornecendo um gerador de documentação livre em execução no Markdown.

Isto é não é um gerador de site estático típico e faz não requer páginas HTML / CSS estáticas. Em vez disso, carrega arquivos Markdown dinamicamente e os exibe como páginas da web. Muito arrumado!

Confira a página inicial do Docsify para uma visualização do layout, junto com mais detalhes de configuração.

Isso requer que você crie o arquivo index.html você mesmo, que pode então ser enviado para as páginas do GitHub ou hospedado em seu próprio servidor. De lá, você só escrever arquivos Markdown para cada página e usá-los como seus documentos principais.

Todo o processo é descrito em detalhes no Guia rápido, então é provavelmente o melhor lugar para começar. Isso pode tudo executado através de npm, por isso realmente ajuda a saber o seu prompt de comando ou pelo menos estar disposto a aprender.

É possível criar um arquivo HTML bruto e copiar / colar o modelo do guia de configuração do Docsify. Mas eu recomendo fazendo isso dinamicamente, desde que economiza uma tonelada de tempo e não é realmente o ponto?

Ao aprender o sistema Docsify, você pode adicionar recursos usando Markdown ou HTML bruto. Esses recursos incluem barra de navegação personalizada e até mesmo sua própria capa com o logotipo do seu projeto.

Docsify mesmo vem embalado com um monte de temas livres se você quiser layouts pré-concebidos para trabalhar. Ou você pode navegar pela galeria de vitrines para ver quais projetos usam o Docsify para sua documentação.

Todos informações básicas de configuração e downloads de arquivos pode ser encontrado no GitHub, então vá até lá se você quiser dar uma chance.

Você também pode veja uma demonstração ao vivo na página principal de documentação do Docsify que, com certeza, é executado no Docsify. Então, se você gosta desse layout de página da Web, pode usar o mesmo modelo e executá-lo por meio do Docsify, 100% gratuito e de código aberto.