nicedoc.io is a presentation layer to beautify any doc file hosted on github.com.
Development
Environment Variables
GITHUB_TOKEN
Required
Since we are interacting with GitHub API, you need to setup a token for authenticating the requests.
See more at Creating a personal access token for the command line on GitHub Help.
PORT
default: 3000
The port to be used for running the HTTP server.
SITE_URL
default: http://localhost:3000
It sets the base URL to be used for resolving relative URLs detected on GitHub.
Getting Started
After npm install, just do a npm run dev.
Community Showcase
Feel free to add your example
- nicedoc.io/ahmadawais/Shades-of-Purple-VSCode.
- nicedoc.io/nucliweb/awesome-css-houdini.
- nicedoc.io/12bitvn/social-image-gen.
- nicedoc.io/helpermethod/spring-boot-style-guide.
License
nicedoc.io © released under the Apache License.
Authored and maintained by Kiko Beats with help from contributors.