doc bump
This commit is contained in:
jackyzha0
parent
d197e19142
commit
2563afe44a
|
|
@ -2,7 +2,10 @@ baseURL = "https://quartz.jzhao.xyz/"
|
|||
languageCode = "en-us"
|
||||
googleAnalytics = "G-XYFD95KB4J"
|
||||
pygmentsUseClasses = true
|
||||
ignoreFiles = ["/content/templates/*"]
|
||||
ignoreFiles = [
|
||||
"/content/templates/*",
|
||||
"/content/private/*",
|
||||
]
|
||||
|
||||
[markup]
|
||||
[markup.tableOfContents]
|
||||
|
|
|
|||
|
|
@ -1,4 +1,6 @@
|
|||
# 🌱 Quartz
|
||||
## v1.1
|
||||
|
||||
Simple second brain and [digital garden](https://jzhao.xyz/posts/digital-gardening).
|
||||
|
||||
## Why Quartz?
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Let's get to business and get you started!
|
|||
- 🎨 [Customizing and Styling Quartz](notes/config.md)
|
||||
- 🌍 [Hosting Quartz online!](notes/hosting.md)
|
||||
|
||||
Not convinced yet? Look at some [cool community digital gardens](moc/showcase)!
|
||||
Not convinced yet? Look at some [community digital gardens](moc/showcase) built with Quartz!
|
||||
|
||||
## Troubleshooting
|
||||
- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ title: "Showcase"
|
|||
Want to see what Quartz can do? Here are some cool community gardens :)
|
||||
|
||||
- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/)
|
||||
- [Jacky Zhao's Garden](https://jzhao.xyz/toc/directory/)
|
||||
- [Jacky Zhao](https://jzhao.xyz/toc/directory/)
|
||||
- [Anson Yu](http://garden.ansonyu.me/)
|
||||
|
||||
If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/hugo/content/moc/showcase.md)!
|
||||
|
|
@ -10,7 +10,12 @@ I *strongly* recommend using [Obsidian](http://obsidian.md/) as a way to edit an
|
|||
|
||||
**🔗 [How to link your Obsidian Vault](notes/obsidian.md)**
|
||||
|
||||
Of course, all the files are in Markdown so you could just use your favourite text editor of choice, I'm not going to stop you!
|
||||
Of course, all the files are in Markdown so you could just use your favourite text editor of choice.
|
||||
|
||||
### 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-notes.md)
|
||||
|
||||
### Folder Structure
|
||||
Here's a rough overview of what's what.
|
||||
|
|
@ -38,36 +43,11 @@ Rest of your content here...
|
|||
```
|
||||
|
||||
## Previewing Changes
|
||||
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
|
||||
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended*.
|
||||
|
||||
### 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.
|
||||
👀 [Preview Quartz Changes](notes/preview-changes.md)
|
||||
|
||||
```shell
|
||||
# Install and link `hugo-obsidian` locally
|
||||
$ go install github.com/jackyzha0/hugo-obsidian
|
||||
|
||||
# Navigate to your local Quartz folder
|
||||
$ cd <location-of-your-local-quartz>
|
||||
|
||||
# Scrape all links in your Quartz folder and generate info for Quartz
|
||||
$ hugo-obsidian -input=content -output=data
|
||||
```
|
||||
|
||||
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
|
||||
|
||||
### Installing Hugo
|
||||
Hugo is the static site generator that powers Quartz. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/).
|
||||
|
||||
```
|
||||
# Navigate to your local Quartz folder
|
||||
$ cd <location-of-your-local-quartz>
|
||||
|
||||
# Start local server
|
||||
$ hugo server
|
||||
|
||||
# View your site in a browser at http://localhost:1313/
|
||||
```
|
||||
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
|
||||
|
||||
## Publishing Changes
|
||||
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: "External Hosting"
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
title: "Deploying to GitHub Pages"
|
||||
title: "Deploying Quartz to the Web"
|
||||
---
|
||||
|
||||
|
||||
## 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! You can head to `<YOUR-GITHUB-USERNAME.github.io/quartz` to see it live.
|
||||
|
||||
|
|
@ -74,6 +73,10 @@ GitHub has some [documentation on this](https://docs.github.com/en/pages/configu
|
|||
3. Wait 30 minutes to an hour for the network changes to kick in.
|
||||
4. Done!
|
||||
|
||||
## External Hosting
|
||||
Don't want to use GitHub Pages? Hugo builds everything for you! Everything is a packaged set of static files ready to deploy in `/public`. You can then upload this folder to a cloud provider to deploy. Alternatively, most providers also give users the option to link a GitHub repository and a folder to deploy. When doing this, ensure you select `/public` folder under the `master` branch.
|
||||
|
||||
---
|
||||
|
||||
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: "Ignoring Notes"
|
||||
---
|
||||
|
||||
### Quartz Ignore
|
||||
Edit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered.
|
||||
|
||||
```toml
|
||||
...
|
||||
ignoreFiles = [
|
||||
"/content/templates/*",
|
||||
"/content/private/*",
|
||||
"<your path here>"
|
||||
]
|
||||
```
|
||||
|
||||
`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\.png$`).
|
||||
|
||||
More details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering).
|
||||
|
||||
### Global Ignore
|
||||
However, just adding to the `ignoreFiles` will only prevent the page from being access through Quartz. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the `.gitignore` file at the root of the repository.
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
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!
|
||||
|
||||
## 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.
|
||||
|
||||
```shell
|
||||
# Install and link `hugo-obsidian` locally
|
||||
$ go install github.com/jackyzha0/hugo-obsidian
|
||||
|
||||
# Navigate to your local Quartz folder
|
||||
$ cd <location-of-your-local-quartz>
|
||||
|
||||
# Scrape all links in your Quartz folder and generate info for Quartz
|
||||
$ hugo-obsidian -input=content -output=data
|
||||
```
|
||||
|
||||
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
|
||||
|
||||
## Installing Hugo
|
||||
Hugo is the static site generator that powers Quartz. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/).
|
||||
|
||||
```
|
||||
# Navigate to your local Quartz folder
|
||||
$ cd <location-of-your-local-quartz>
|
||||
|
||||
# Start local server
|
||||
$ hugo server
|
||||
|
||||
# View your site in a browser at http://localhost:1313/
|
||||
```
|
||||
|
|
@ -3,6 +3,12 @@ title: "Troubleshooting and FAQ"
|
|||
---
|
||||
|
||||
## Common Pitfalls
|
||||
### Can I publish only a subset of my pages?
|
||||
Yes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore-notes.md).
|
||||
|
||||
### Can I host this myself and not on GitHub Pages?
|
||||
Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).
|
||||
|
||||
### Do I need a website already?
|
||||
No! Setting up Quartz means you set up a site too :)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "Private Stuff"
|
||||
---
|
||||
|
||||
This page doesn't get published!
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
{{partial "darkmode.html" .}}
|
||||
<div class="centered">
|
||||
<h1>404.</h1>
|
||||
<h3>Hey! You look a little lost.</h3>
|
||||
<h3>Hey! You look a little lost. This page doesn't exist (or may be private).</h3>
|
||||
<a href="/">↳ Let's get you home.</a>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue