https://github.com/IBM/nicedoc.io

pretty README as service.
https://github.com/IBM/nicedoc.io

Last synced: 9 days ago
JSON representation

pretty README as service.

• Host: GitHub
• URL: https://github.com/IBM/nicedoc.io
• Owner: IBM
• License: apache-2.0
• Archived: true
• Created: 2018-12-26T08:40:02.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-05T16:39:11.000Z (over 4 years ago)
• Last Synced: 2024-07-31T18:24:13.440Z (3 months ago)
• Language: JavaScript
• Homepage: https://nicedoc.io
• Size: 1.5 MB
• Stars: 472
• Watchers: 14
• Forks: 30
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome - IBM/nicedoc.io - pretty README as service. (JavaScript)

README

        
![](/static/banner.jpg)

**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.

![](https://i.imgur.com/6cmrVud.png)

See more at [Creating a personal access token for the command line](https://help.github.com/en/articles/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](https://nicedoc.io/ahmadawais/Shades-of-Purple-VSCode).

- [nicedoc.io/nucliweb/awesome-css-houdini](https://nicedoc.io/nucliweb/awesome-css-houdini).

- [nicedoc.io/12bitvn/social-image-gen](https://nicedoc.io/12bitvn/social-image-gen).

- [nicedoc.io/helpermethod/spring-boot-style-guide](https://nicedoc.io/helpermethod/spring-boot-style-guide).

## License

**nicedoc.io** © released under the [Apache](/LICENSE.md) License.


Authored and maintained by [Kiko Beats](https://github.com/Kikobeats) with help from [contributors](https://github.com/IBMResearch/nicedoc.io/graphs/contributors).