| | |
|---|
| | | |
|---|
| | | However, if you'd like to publish your site to the world, you need a way to host it online. This guide will detail how to deploy with either GitHub Pages or Cloudflare pages but any service that allows you to deploy static HTML should work as well (e.g. Netlify, Replit, etc.) |
|---|
| | | |
|---|
| | | > [!hint] |
|---|
| | | > Some Quartz features (like [[RSS Feed]] and sitemap generation) require `baseUrl` to be configured properly in your [[configuration]] to work properly. Make sure you set this before deploying! |
|---|
| | | |
|---|
| | | ## Cloudflare Pages |
|---|
| | | |
|---|
| | | 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account. |
|---|
| | |
|---|
| | | |
|---|
| | | | Configuration option | Value | |
|---|
| | | | ---------------------- | ------------------ | |
|---|
| | | | Production branch | `v4-alpha` | |
|---|
| | | | Production branch | `v4` | |
|---|
| | | | Framework preset | `None` | |
|---|
| | | | Build command | `npx quartz build` | |
|---|
| | | | Build output directory | `public` | |
|---|
| | | |
|---|
| | | Press "Save and deploy" and Cloudflare should have a deployed version of your site in about a minute. Then, every time you sync your Quartz changes to GitHub, your site should be updated. |
|---|
| | | |
|---|
| | | To add a custom domain, check our [Cloudflare's documentation](https://developers.cloudflare.com/pages/platform/custom-domains/). |
|---|
| | | To add a custom domain, check out [Cloudflare's documentation](https://developers.cloudflare.com/pages/platform/custom-domains/). |
|---|
| | | |
|---|
| | | ## GitHub Pages |
|---|
| | | |
|---|
| | | 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: |
|---|
| | | push: |
|---|
| | | branches: |
|---|
| | | - v4-alpha |
|---|
| | | - v4 |
|---|
| | | |
|---|
| | | permissions: |
|---|
| | | contents: read |
|---|
| | |
|---|
| | | 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 |
|---|
| | | fetch-depth: 0 # Fetch all history for git info |
|---|
| | | - uses: actions/setup-node@v3 |
|---|
| | | with: |
|---|
| | | node-version: 18.14 |
|---|
| | | - name: Install Dependencies |
|---|
| | |
|---|
| | | 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>`. |
|---|
| | | |
|---|
| | | > [!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 |
|---|
| | | |
|---|
| | |
|---|
| | | - `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. |
|---|
| | | |
|---|
