Documenting your any GitHub repositories using nicedoc.io

Today, we are going to use the nicedoc.io to document our GitHub repositories readme.md in beautiful, nicely formatted documents with the feature of light/dark mode.

First, you go to any of GitHub repository that you want to read like a document. Make sure it’s having a readme.md file for documentation and copy the URL same like this.

We can’t write your project documentation for you, but we can help you have an instant documentation site ready for your users.

For any Repository

where Prakash106 is the username and electron-hello-world is the repository name.

nicedoc.io/Prakash106/electron-hello-world

For any markup file into a subdirectory

If in case, your markup file into the sub-directory so you can also use the file path. Here user-handbook.md is the file for documentation.

nicedoc.io/thejameskyle/…/user-handbook.md

For any git reference

Directly point to git reference

https://nicedoc.io/GoogleChromeLabs/quicklink@1.0.0

Examples

Here is some example, to check how awesome it is. For more nicedocs.io

substack/stream-handbook
jsdom/jsdom
cheeriojs/cheerio
jamiebuilds/babel-handbook
awesome-ui-component-library
cyrilwanner/next-optimized-images