pretty README as service.
nicedoc.io/:org/:repo[@:ref]

Features

  • Automatically generated documentation sites for your markdown files.
  • Compatible with any doc file hosted on github.com.
  • Point to a git hash reference in any markup format.
  • Light & Dark mode support.

Why

Software documentation is a lie: nobody wants to do it but everyone wants to have it.
We can't write your project documentation for you, but we can help you have an instant documentation site ready for your users.

Examples