DibyashanuPati/quartz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs on github pages and syncing

Browse source
This commit is contained in:
Jacky Zhao 2023-08-18 18:22:38 -07:00
parent 6f1f820289
commit d8bec631b6
2 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
content/hosting.md
View file

@ -53,7 +53,7 @@ jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0 # Fetch all history for git info
- uses: actions/setup-node@v3
@ -85,6 +85,11 @@ Then:
1. Head to "Settings" tab of your forked repository and in the sidebar, click "Pages". Under "Source", select "GitHub Actions".
2. Commit these changes by doing `npx quartz sync`. This should deploy your site to `<github-username>.github.io/<repository-name>`.
> [!hint]
> If you get an error about not being allowed to deploy to `github-pages` due to environment protection rules, make sure you remove any existing GitHub pages environments.
>
> You can do this by going to your Settings page on your GitHub fork and going to the Environments tab and pressing the trash icon. The GitHub action will recreate the environment for you correctly the next time you sync your Quartz.
### Custom Domain
Here's how to add a custom domain to your GitHub pages deployment.