gh-pages-readme
v1.0.0
Published
Automatically generate GitHub pages from contents of README
Downloads
3
Readme
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/[email protected]/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');