Sha256: a06ca15d3741bee90bfca995868197254382d7862d76d8db65caefdea30790b8

Contents?: true

Size: 631 Bytes

Versions: 12

Compression:

Stored size: 631 Bytes

Contents

# GitHub Pages Integration

This guide shows you how to use `utopia-project` with GitHub Pages.

## Static Site Generation

Once you are happy with your project's documentation, simply generate a static site:

~~~ bash
$ bake utopia:project:static
~~~

This will generate a static copy of your documentation into `docs/` which is what is required by GitHub Pages.

## Enable GitHub Pages

In your GitHub project settings, you will need to [enable GitHub Pages served from `docs/`](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
utopia-project-0.7.1 guides/github-pages-integration/README.md
utopia-project-0.7.0 guides/github-pages-integration/README.md
utopia-project-0.6.2 guides/github-pages-integration/README.md
utopia-project-0.6.1 guides/github-pages-integration/README.md
utopia-project-0.6.0 guides/github-pages-integration/README.md
utopia-project-0.5.1 guides/github-pages-integration/README.md
utopia-project-0.5.0 guides/github-pages-integration/README.md
utopia-project-0.4.0 guides/github-pages-integration/README.md
utopia-project-0.3.0 guides/github-pages-integration/README.md
utopia-project-0.2.1 guides/github-pages-integration/README.md
utopia-project-0.2.0 guides/github-pages-integration/README.md
utopia-project-0.1.0 guides/github-pages-integration/README.md