gh-pages-readme

1.0.0 • Public • Published

gh-pages-readme

Generate contents of GitHub pages automatically from README.md of your repository, styled with Bootstrap.

Usage

Create branch called gh-pages in your repository, add file index.html with following contents, then commit and push your changes:

<script src="https://cdn.jsdelivr.net/npm/gh-pages-readme@1.0.0/lib/index.js"></script>
<script>
  ghpages.init('user/repository');
</script>

Replace user/repository with your GitHub username and name of the repository.

Super duper advanced usage

You can pass second argument to ghpages.init function which specifies from which branch the README.md will be retrieved from. By default it uses main branch.

ghpages.init('user/repository', 'development');

Readme

Keywords

none

Package Sidebar

Install

npm i gh-pages-readme

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

305 kB

Total Files

7

Last publish

Collaborators

  • rauli