Skip to content

Commit

Permalink
update deploy instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
chrjabs committed Feb 8, 2024
1 parent 7a031c1 commit 9aa50ba
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 43 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,20 +71,17 @@ They can be manually generated or automatically from one of your publication ent

## Publishing

Grape-Academic-Theme uses jekyll-scholar and therefore needs to manually be published to GitHub pages.
A script for publishing on a `gh-pages` branch is included.
Run `_scripts/publish.sh` from the main project directory and the page will be built, copied to the `gh-pages` branch and published.
Make sure that GitHub pages is set up to publish that branch.
If additional scripts should be executed in the HTML root, they can be placed in `_scripts/publish.d` and will be automatically executed.
Since GitHub changed pages deployment to be based on Actions, Grape-Academic-Theme can be deployed fully automatically.
This project already contains the necessary GitHub workflow.

These are step-by-step instructions for forking and publishing the theme at your `<username>.github.io` github pages website:

1. For the repository to a repository named `<username>/<username>.github.io`
2. Go to the settings of the new repository and navigate to the "Pages" tab.
There, change the source for github pages to the `gh-pages` branch of the repository.
There, change the source for github pages to "GitHub Actions".
3. Clone the repository and go through the installation steps listed above
4. In `_config.yml`, change the `baseurl` option to an empty string (`""`) to host the webpage in the root of your `github.io` page
5. Commit the change and (with a working jekyll install) run `_scripts/publish.sh`
5. Push to GitHub and see the workflow building and publishing your website.
6. _Wait a couple of minutes_ and the demo content will show up at `<username>.github.io`

## Customizing
Expand Down Expand Up @@ -229,4 +226,4 @@ You can confirm how to draw tags at [here](https://grape-theme.netlify.com/2019/

## Licence

The theme is available as open source under the terms of the [MIT Licence](https://opensource.org/licenses/MIT).
The theme is available as open source under the terms of the [MIT Licence](https://opensource.org/licenses/MIT).
4 changes: 0 additions & 4 deletions _scripts/publish.d/example.sh

This file was deleted.

31 changes: 0 additions & 31 deletions _scripts/publish.sh

This file was deleted.

0 comments on commit 9aa50ba

Please sign in to comment.