Geradores de Documentação Estática

Artigo

Yuri Marx · jan 25, 2021 2min de leitura

Open Exchange

#Ambiente de Desenvolvimento #InterSystems IRIS

Olá comunidade,

No passado, a documentação técnica do código-fonte e dos produtos de software era gerada em chm, arquivos pdf e geradores de documentação das próprias linguagens de programação. Essa abordagem antiga tinha as seguintes limitações:
1. Documentação desatualizada;
2. Documentação não interativa e de difícil consulta;
3. Layout sem resposta, não amigável e não aderente ao HTML;
4. Incapacidade de customizar o layout da documentação;
5. Incapacidade de ter documentação HTML 5 online e offline.
6. Falta de suporte de Markdown.

Hoje, existem várias soluções de geração de documentação que produzem Portais de Documentação Web muito atrativos, interativos, responsivos e com opções estáticas e dinâmicas, com suporte total para HTML 5 e mais recentemente Markdown.

Veja a tabela com as opções de código aberto mais populares:

Documentação do Produto	Estrelas
MkDocs Github Repo: https://github.com/mkdocs/mkdocs Geração de documentação estática e dinâmica Simples, leve e construído em Python Caixa de pesquisa de texto completo inteligente Vários temas e plug-ins Suporte para Markdown e HTML Integração com páginas Git Extensível usando Python Arquitetura SPA	11.4k
Docsify Github Repo: https://github.com/docsifyjs/docsify Nenhum arquivo html construído estaticamente Simples e leve (~ 21kB gzipado) Plug-in inteligente de pesquisa de texto completo Vários temas API de plugin simples Compatível com IE11 Suporte SSR Suporte a arquivos incorporados	16.5k
Docusaurus Github: https://github.com/facebook/docusaurus/ Desenvolvido por Markdown Construído usando React Pronto para traduções Controle de versão de documento Pesquisa de Documentos Configuração rápida	21.4k
Slate Github: https://github.com/slatedocs/slate Design limpo e intuitivo Documentação de página única Suporte a Markdown Destaque de sintaxe embutido Escreva amostras de código em vários idiomas Índice automático de rolagem suave A documentação é editável pelos usuários através do Github Suporte RTL	31.9k

O IRIS Publisher no Open Exchange permite que você extraia blocos de documentação XData em HTML ou Markdown e gere o site de documentação de seu aplicativo usando MkDocs. Consulte as instruções no artigo: https://community.intersystems.com/post/creating-documentation-portal-your-intersystems-iris-application.

Se você gostou, vote no meu app: https://openexchange.intersystems.com/contest/current

Ref: https://dev.to/nafis/5-free-static-documentation-generators-you-must-check-out-5ged

Confira o aplicativo relacionado no InterSystems Open Exchange