Skip to content

Commit

Permalink
chore: document steps to deploy to github pages (#31)
Browse files Browse the repository at this point in the history
Co-authored-by: Liran Tal <[email protected]>
  • Loading branch information
estherixz and lirantal authored Feb 12, 2022
1 parent 4b453d0 commit 4f257c8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,17 @@ Use npm's built-in `npx` command to fetch, install, and run gigsboat with no con
npx @gigsboat/cli
```

## Deploying to GitHub Pages

It is possible to deploy the generated README.md file to github pages. All that is needed, is to enable github-pages in the repository's *settings* > *pages*, as is described in the [github pages docs](https://docs.github.com/en/pages/quickstart#creating-your-website), starting from _step 3_.

To access the generated site visit
`https://<username-or-org>.github.io/<template-repo-name>`

To select a different theme than the default or to customise it, add a __config.yml_ file and include `theme: jekyll-theme-minimal`. From the same __config.yml_ file, it's also possible to set a `title` and `description` for the gerated html. For more details on theme customisation follow the steps described in [adding a theme to your jekyll site](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll).

## Generating a static site

You can use several static site generators to output an html from the generated README.md file. Using jekyll, is great if you want to deploy to github pages. But if you're looking to deploy somewhere else, you might want to use a different tool like [11ty](https://www.11ty.dev/). We have created a guide in [GENERATE_11ty_STATIC_SITE.md](GENERATE_11ty_STATIC_SITE.md) to get you started.

# Contributing
Expand Down

0 comments on commit 4f257c8

Please sign in to comment.