Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Corrected GitHub Deployment Instructions #111

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Corrected GitHub Deployment Instructions #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,20 @@ Use Netlify to deploy this theme. This theme contains a valid and tested `netlif

### Github Pages

This theme has been tested to work with Github Pages (and Github Project Pages). When using Github Pages you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.

For example the site https://zerostaticthemes.github.io/jekyll-serif-theme would have `baseurl: "/jekyll-serif-theme/"`
This theme has been tested to work with Github Pages (and Github Project Pages).

1. Create a Fork of this GitHub Repository. If you want the theme to be hosted at https://username.github.io/ rather than https://username.github.io/repository_name you should name the repository `username.github.io`.
2. Edit the `_config.yml` file adding the following two lines.
url: "https://username.github.io/repository_name"
remote_theme: zerostaticthemes/jekyll-serif-theme
3. You will also need to update the `baseurl` in the `_config.yml` file if you're hosting this in a repository otherwise all the css, images and paths will be broken. For example the site https://zerostaticthemes.github.io/jekyll-serif-theme would have `baseurl: "/jekyll-serif-theme/"`
4. Go to `Repository Settings > Pages`.
a. Click Pages under Code and automation.
b. Change Source under Build and deployment from Deploy from a branch to GitHub Actions.
5. Go to the Actions tab on your repository.
a. Start a New workflow and search for Jekyll.
b. Click Configure under the Jekyll workflow (not GitHub Pages Jekyll workflow).
c. Review the change and click Commit changes.

## Extras

Expand Down