Skip to content
Use your github README as a website.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
dark.css
index.js
now.json
package-lock.json
package.json
readme.md
styles.css

readme.md

GoDoc 

Use your github README as a website. Example: https://godoc.now.sh/pablopunk/godoc

Usage

Just append <your-user>/<your-repo> to godoc.now.sh and you will see your readme right there.

You can also use an alternative dark mode. Just append ?dark to your url. Example: https://godoc.now.sh/pablopunk/iga?dark

Use your custom domain

For example, I deployed pablopunk.com in order to redirect subfolders to GoDoc:

pablopunk.com/iga redirects to godoc.now.sh/pablopunk/iga?dark

Notice the GoDoc url is kind of large, but with my custom domain, I can have it nice and short even with dark mode.

You can’t perform that action at this time.