Skip to main content

Site Tool

· 2 min read
David Puziol Prata
DevOps at @ Encora

Olá leitores,

Existem várias ferramentas para escrever documentação de projeto usando markdown.

As principais que conheço são:

O que eu busco é criar um site estático sem aplicativos rodando em segundo plano, sem banco de dados, somente páginas de leitura com muita documentação e que seja fácil de fazer backup e versionar.

gitbook

  • É pago se for colaborativo, ou seja, é bom para trabalhar sozinho.
  • Preço alto por cada membro do time ($6.70)
  • Não precisa gastar tempo deployando um website
  • Interface online para alterar a documentação
  • Domínio personalizado

retype

  • Não possui custo até sem 100 páginas por projeto ou se for removido a logo do retype.
  • Somente um projeto free por usuário
  • Número de colaboradores ilimitados em um projeto
  • Não precisa gastar tempo deployando um website
  • Domínio personalizado

docusaurus

  • Open Source: Não existe nenhum custo
  • Curva de aprendizado um pouco maior, mas possui uma ótima documentação
  • Não possui uma interface web para alteração. Toda alteração deve ser feito diretório no código fonte editando os arquivos markdown.
  • Maior quantidade de recursos disponíveis

Escolhi o Docusaurus pois posso aceitar merge requests de outras pessoas e publicar direto no site usando o Netifly

Mais tarde farei uma documentação sobre isso.