Skip to main content

Site Tool

· 2 min read
David Puziol Prata
David Puziol Prata
DevOps at @ Encora

Hello readers,

There are several tools for writing project documentation using markdown.

The main ones I know are:

What I'm looking for is to create a static site without background applications, without a database, only read-only pages with lots of documentation that is easy to backup and version.

gitbook

  • It's paid if collaborative, meaning it's good for working alone.
  • High price per team member ($6.70)
  • No need to spend time deploying a website
  • Online interface to change documentation
  • Custom domain

retype

  • No cost up to 100 pages per project or if the Retype logo is removed.
  • Only one free project per user
  • Unlimited number of collaborators on a project
  • No need to spend time deploying a website
  • Custom domain

docusaurus

  • Open Source: No cost
  • Slightly steeper learning curve, but has excellent documentation
  • No web interface for changes. All changes must be made directly in the source code by editing markdown files.
  • Greater number of available features

I chose Docusaurus because I can accept merge requests from other people and publish directly to the site using Netlify

I'll make documentation about this later.