@olian/github-readme

github-readme

A custom element that renders the readme of a github repository

<script src="https://unpkg.com/@olian/github-readme"></script>
<github-readme
    user="olian04"
    repository="github-readme"
    ></github-readme>

Click here to see this page rendered using github-readme :smile:

Or click here to see a multi page demo in a jsfiddle

Install

npm install @olian/github-readme

Advanced

<github-readme
    user="olian04"
    repository="github-readme"
    branch="master"
    index="/README.md"
    navigation="full"
    bookmarks="[License](/LICENSE);[Demo](/index.html)"
    style=""
    id=""
    class=""
    ></github-readme>

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.

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

TODO:

• Mobile support
• Add cache for offline browsing (this will eliminate the problems with rate limits on the github api)
• Syntax highlighting for codeblocks