From 4f257c8dbb8ddfab8de9f9e8e5e4b999d2559e01 Mon Sep 17 00:00:00 2001 From: Esther Saimpou <8407403+estherixz@users.noreply.github.com> Date: Sat, 12 Feb 2022 17:39:00 +0100 Subject: [PATCH] chore: document steps to deploy to github pages (#31) Co-authored-by: Liran Tal --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a2a92c8..0b58bbc 100644 --- a/README.md +++ b/README.md @@ -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://.github.io/` + +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