42
GitHub - IBM/nicedoc.io: pretty README as service.
source link: https://github.com/IBM/nicedoc.io
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
nicedoc.io is a presentation layer for 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
License
nicedoc.io © released under the Apache License.
Authored and maintained by Kiko Beats with help from contributors.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK