Skip to content

Commit

Permalink
Add instructions for deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
WillHannon-MCB committed Aug 12, 2024
1 parent 6a65a33 commit 9228d97
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,3 +224,7 @@ An interactive web tool for visualizing site-level data on a protein structure w

### Editing the home page and section home pages
While the individual posts can be edited by just editing the Markdown, to edit the homepage and the top text for each section (*Blog*, *Team*, *Papers*, *Software*) you will need to edit the corresponding `*.vue` file at [.vitepress/theme](.vitepress/theme) (eg, [.vitepress/theme/Home.vue](.vitepress/theme/Home.vue) for the home page).

## Deployment

The deployment is handled by GitHub Actions. A workflow script located at [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) is run on **pushes** or **pull requests** to the `main` branch. The workflow script builds the website using `npm run build` and copies the contents of the resulting `.dist/` directory to a branch called `gh-pages`. The website is automatically deployed from the root of this branch by GitHub Pages.

0 comments on commit 9228d97

Please sign in to comment.