https://github.com/Olian04/github-readme

A custom element that renders the readme of a github repository
https://github.com/Olian04/github-readme

Last synced: about 2 months ago
JSON representation

A custom element that renders the readme of a github repository

• Host: GitHub
• URL: https://github.com/Olian04/github-readme
• Owner: Olian04
• License: mit
• Created: 2018-11-09T11:07:07.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-20T10:03:55.000Z (over 5 years ago)
• Last Synced: 2024-07-28T06:08:16.654Z (2 months ago)
• Language: JavaScript
• Homepage: https://olian04.github.io/github-readme/
• Size: 82 KB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github-readme

A custom element that renders the readme of a github repository

```html

```

[Click here to see this page rendered using `github-readme`](https://olian04.github.io/github-readme) :smile:

Or [click here to see a multi page demo in a jsfiddle](https://jsfiddle.net/cLyum7jr/33/)

__Help me help you:__ 

## Install

__NPM:__ [`npm install @olian/github-readme`](https://www.npmjs.com/package/@olian/github-readme)

__CDN:__ ``

## Advanced

```html

```

|property | default | description|

|:-----------:|:----------:|:--------------|

|user |  | The name of the github user that owns the repository|

|repository |  | The name of the github repository you want to display|

|branch | master | The name of the git branch you want to display|

|index | /README.md | The path to the index file.|

|navigation | full | `none` will hide the navigation bar. `history` will only show the back, forward and reload buttons. `full` will show the history navigation as well as a bookmarks row.|

|bookmarks | | Optional bookmarks provided in the form of a simecolon separated string of markdown links. `[TITLE](LINK);[TITLE](LINK);[TITLE](LINK)`|

|style |  | Optional styles passed down to the top most element of the component.|

|id |  | Optional id passed down to the top most element of the component.|

|class |  | Optional class passed down to the top most element of the component.|

_**Note:** github-readme uses unauthenticated requests to the github api and is there for limited by [its rate limiting rules](https://developer.github.com/v3/#rate-limiting)._

> For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests.

## License

See [Licence](/LICENSE)