malczak / nicedoc.io

pretty README as service.

Home Page:https://nicedoc.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

License

nicedoc.io © released under the Apache License.
Authored and maintained by Kiko Beats with help from contributors.

About

pretty README as service.

https://nicedoc.io

License:Apache License 2.0


Languages

Language:JavaScript 87.7%Language:CSS 9.7%Language:Shell 2.4%Language:Dockerfile 0.2%