| | |
|---|
| | | title: "Deploying Quartz to the Web" |
|---|
| | | tags: |
|---|
| | | - setup |
|---|
| | | weight: -1 |
|---|
| | | aliases: |
|---|
| | | - hosting |
|---|
| | | --- |
|---|
| | | |
|---|
| | | ## GitHub Pages |
|---|
| | | ## Hosting on GitHub Pages |
|---|
| | | Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below. |
|---|
| | | |
|---|
| | | ### Enable GitHub Actions |
|---|
| | |
|---|
| | | ### Setting up the Site |
|---|
| | | Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too. |
|---|
| | | |
|---|
| | | Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. |
|---|
| | | Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. |
|---|
| | | |
|---|
| | | Make sure that your `baseURL` has a trailing `/`! |
|---|
| | | |
|---|
| | |
|---|
| | | baseURL = "https://<YOUR-DOMAIN>/" |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`. |
|---|
| | | If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!** |
|---|
| | | |
|---|
| | | ```toml |
|---|
| | | baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/" |
|---|
| | |
|---|
| | | |
|---|
| | | [Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml) |
|---|
| | | |
|---|
| | | ```yaml |
|---|
| | | ```yaml {title=".github/workflows/deploy.yaml"} |
|---|
| | | - name: Deploy |
|---|
| | | uses: peaceiris/actions-gh-pages@v3 |
|---|
| | | with: |
|---|
| | |
|---|
| | | |
|---|
| | | Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md). |
|---|
| | | |
|---|
| | | ### Ignoring Files |
|---|
| | | Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process. |
|---|
| | | |
|---|
| | | ❌ [Excluding pages from being published](notes/ignore%20notes.md) |
|---|
| | | |
|---|
| | | --- |
|---|
| | | |
|---|
| | | Now that your Quartz is live, let's figure out how to make Quartz really *yours*! |
|---|
| | | |
|---|
| | | 🎨 [Customizing Quartz](notes/config.md) |
|---|
| | | > Step 6: 🎨 [Customizing Quartz](notes/config.md) |
|---|
| | | |
|---|
| | | Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). |
|---|
