yuriy/quartz-website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs updates

Browse Source
This commit is contained in:
Jacky Zhao
2022-02-17 10:44:39 -05:00
parent f192f9a23d
commit 388a2bf78b
4 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/notes/editing.md
View File

@@ -24,7 +24,7 @@ Here's a rough overview of what's what.
**All content in your garden can found in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you'd like. **All content in your garden can found in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you'd like.
**To edit the main home page, open `/content/_index.md`.** This is the home page which is slightly special. You don't need front matter here! **To edit the main home page, open `/content/_index.md`.*
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**. To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
@@ -33,7 +33,7 @@ For example, I want to link this current document to `notes/config.md`.
[A link to the config page](notes/config.md) [A link to the config page](notes/config.md)
``` ```
Similarly, you can put local images anywhere in the `/content` folder. The only caveat is that you should reference them in your Markdown by prefixing it with a `/`. Similarly, you can put local images anywhere in the `/content` folder.
```markdown ```markdown
Example image (source is in content/notes/images/example.png) Example image (source is in content/notes/images/example.png)

10
content/notes/hosting.md
View File

@@ -16,13 +16,13 @@ By default, GitHub disables workflows from running automatically on Forked Repos
Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab. Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab.
1. (IMPORTANT) Set the source to deploy from `master` using `/ (root)` 1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`
2. Set a custom domain here if you have one! 2. Set a custom domain here if you have one!
![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages* ![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages*
### Pushing Changes ### Pushing Changes
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a `git` repository so updating it is the same workflow as you would follow as normal. To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project.
```shell ```shell
# Navigate to Quartz folder # Navigate to Quartz folder
@@ -43,13 +43,15 @@ Now let's get this site up and running. Never hosted a site before? No problem.
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 `/`!
[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml) [Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)
```toml ```toml
baseURL = "https://<YOUR-DOMAIN>/" baseURL = "https://<YOUR-DOMAIN>/"
``` ```
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing path. If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`.
```toml ```toml
baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/" baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
@@ -57,6 +59,8 @@ baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`. Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`.
Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.
[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml) [Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
```yaml ```yaml

6
content/notes/preview changes.md
View File

@@ -4,6 +4,8 @@ title: "Preview Changes"
If you'd like to preview what your Quartz site looks like before deploying it to the internet, here's exactly how to do that! If you'd like to preview what your Quartz site looks like before deploying it to the internet, here's exactly how to do that!
Note that both of these steps need to be completed.
## Install `hugo-obsidian` ## Install `hugo-obsidian`
This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed. This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed.
@@ -15,9 +17,11 @@ $ go install github.com/jackyzha0/hugo-obsidian@latest
$ cd <location-of-your-local-quartz> $ cd <location-of-your-local-quartz>
# Scrape all links in your Quartz folder and generate info for Quartz # Scrape all links in your Quartz folder and generate info for Quartz
$ hugo-obsidian -input=content -output=data -index -root=. $ hugo-obsidian -input=content -output=static -index -root=.
``` ```
If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
## Installing Hugo ## Installing Hugo

3
content/notes/troubleshooting.md
View File

@@ -6,6 +6,9 @@ Still having trouble? Here are a list of common questions and problems people en
While you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :) While you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)
### My GitHub pages is just showing the README and not Quartz
Make sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide
### Some of my pages have 'January 1, 0001' as the last modified date ### Some of my pages have 'January 1, 0001' as the last modified date
This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command. This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command.