| | |
|---|
| | | |
|---|
| | | Like Quartz 3, you can deploy the site generated by Quartz 4 via GitHub Pages. |
|---|
| | | |
|---|
| | | In your local Quartz, create a new file `quartz/.github/workflows/deploy.yaml`. |
|---|
| | | In your local Quartz, create a new file `quartz/.github/workflows/deploy.yml`. |
|---|
| | | |
|---|
| | | ```yaml title="quartz/.github/workflows/deploy.yaml" |
|---|
| | | ```yaml title="quartz/.github/workflows/deploy.yml" |
|---|
| | | name: Deploy Quartz site to GitHub Pages |
|---|
| | | |
|---|
| | | on: |
|---|
| | |
|---|
| | | steps: |
|---|
| | | - uses: actions/checkout@v2 |
|---|
| | | with: |
|---|
| | | fetch-depth: 0 # Fetch all history for git info |
|---|
| | | fetch-depth: 0 # Fetch all history for git info |
|---|
| | | - uses: actions/setup-node@v3 |
|---|
| | | with: |
|---|
| | | node-version: 18.14 |
|---|
| | |
|---|
| | | uses: actions/deploy-pages@v2 |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | Then, commit these changes by doing `npx quartz sync`. This should deploy your site to `<github-username>.github.io/<repository-name>`. |
|---|
| | | 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>`. |
|---|
| | | |
|---|
| | | ### Custom Domain |
|---|
| | | |
|---|
| | |
|---|
| | | - `185.199.111.153` |
|---|
| | | - If you are using a subdomain, navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `quartz.example.com` for your user site, create a `CNAME` record that points `quartz.example.com` to `<github-username>.github.io`. |
|---|
| | | |
|---|
| | | ![[dns-records.png]]_The above shows a screenshot of Google Domains configured for both `jzhao.xyz` (an apex domain) and `quartz.jzhao.xyz` (a subdomain)._ |
|---|
| | | ![[dns records.png]]_The above shows a screenshot of Google Domains configured for both `jzhao.xyz` (an apex domain) and `quartz.jzhao.xyz` (a subdomain)._ |
|---|
| | | |
|---|
| | | See the [GitHub documentation](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain) for more detail about how to setup your own custom domain with GitHub Pages. |
|---|
| | | |
|---|
