pretty README as service (source code).
nicedoc.io/:org/:repo[@:ref]

Features

  • Instant beautiful documentation for any github.com repository.
  • Compatible with any markup format.
  • Point to any git hash or branch.
  • File-system based routing.
  • Light / Dark theme support.

Why

nicedoc.io aims to reduce the documentation friction, converting any markup file hosted on github.com into an instant beauty documentation.
any markup file into subdirectory
nicedoc.io/thejameskyle/…/user-handbook.md
We can't write your project documentation for you, but we can help you have an instant documentation site ready for your users.

Examples