diff --git a/404.html b/404.html index f2373bc74..e1a438469 100644 --- a/404.html +++ b/404.html @@ -1,35 +1,6 @@ - - - - -404 Page not found - - - - - - - +404 Page not found + - - - - - - -
-
- - - -
-
-

404.

-

Hey! You look a little lost. This page doesn't exist (or may be private).

-↳ Let's get you home. -
-
- - \ No newline at end of file + +
+

404.

Hey! You look a little lost. This page doesn't exist (or may be private).

↳ Let's get you home.
\ No newline at end of file diff --git a/categories/index.html b/categories/index.html index 8d5f663df..6894b0e20 100644 --- a/categories/index.html +++ b/categories/index.html @@ -1,83 +1,8 @@ - - - - -Categories - - - - - - - +Categories + - - - - - - -
-
- -
-
-
-
- - -
-
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search -
-
- - - -
-
-
-

All Categories

-
-
-

setup

-

5 notes with this tag (showing first 2 results)

-
-
  • -
    -
    -

    Setup

    -

    Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

    -
    -

    -2 minute read. Last updated April 5, 2022 -

    -
    -
  • -
    -
    -

    Obsidian Vault Integration

    -

    Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

    -
    -

    -2 minute read. Last updated April 5, 2022 -

    -
    -
-
-
-
- -
-
- - - - \ No newline at end of file + +
+

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

All Categories

setup

5 notes with this tag (showing first 2 results)

  • Setup

    Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

    2 minute read. Last updated April 5, 2022

  • Obsidian Vault Integration

    Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

    2 minute read. Last updated April 5, 2022

+ \ No newline at end of file diff --git a/index.html b/index.html index cc64dfd0e..d8b4debd2 100644 --- a/index.html +++ b/index.html @@ -1,108 +1,16 @@ - - - - - -πŸͺ΄ Quartz 3.2 - - - - - - - +πŸͺ΄ Quartz 3.2 + - - - - - - -
-
- -
-
-
-
- - -
-
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search -
-
- - - -
-
-
-

Host your second brain and -digital garden for free. Quartz features

-
    -
  1. Extremely fast full-text search by pressing Ctrl + k
    2. -
  2. Customizable and hackable design based on Hugo
    3. -
  3. Automatically generated backlinks, link previews, and local graph
    4. -
  4. Built-in CJK + Latex Support
    5. -
  5. Support for both Markdown Links and Wikilinks
    6. -
-

Get Started

-
-

πŸ“š -Setup your own digital garden using Quartz

-
-

Not convinced yet? Look at some + +

+

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

Host your second brain and +digital garden for free. Quartz features

  1. Extremely fast full-text search by pressing Ctrl + k
  2. Customizable and hackable design based on Hugo
  3. Automatically generated backlinks, link previews, and local graph
  4. Built-in CJK + Latex Support
  5. Support for both Markdown Links and Wikilinks

Get Started

πŸ“š +Setup your own digital garden using Quartz

Not convinced yet? Look at some community digital gardens built with Quartz, or read about -why I made Quartz to begin with.

-

Content Lists

-

If you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too:

- -

Troubleshooting

- -
-
-
-
-

Backlinks

-
    -
  • -No backlinks found -
    • -
-
-
- -

Interactive Graph

-
- - - -
-
-
- -
- - -
- - \ No newline at end of file +why I made Quartz to begin with.

Content Lists

If you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too:

Troubleshooting

Backlinks

  • No backlinks found

Interactive Graph

+
+
\ No newline at end of file diff --git a/index.xml b/index.xml index e5c739f31..d81b3b1b0 100644 --- a/index.xml +++ b/index.xml @@ -4,5 +4,5 @@ Latex Block math works with two dollar signs $$.Configurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get.Custom Domainhttps://quartz.jzhao.xyz/notes/custom-Domain/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/custom-Domain/Registrar This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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!Editing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown. Obsidian I recommend using Obsidian as a way to edit and grow your digital garden.Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered. 1 2 3 4 5 6 .Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/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!Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/philosophy/β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.Setuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!Showcasehttps://quartz.jzhao.xyz/notes/showcase/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/showcase/Want to see what Quartz can do? Here are some cool community gardens :) -Quartz Documentation (this site!) Strengthening Online Social Bonds: Research Garden Jacky Zhao’s Garden Anson Yu’s Garden Shihyu’s PKM Chloe’s Garden SlRvb’s Site Course notes for Information Technology Advanced Theory Brandon Boswell’s Garden Siyang’s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. +Quartz Documentation (this site!) Jacky Zhao’s Garden AWAGMI Intern Notes Shihyu’s PKM Chloe’s Garden SlRvb’s Site Course notes for Information Technology Advanced Theory Brandon Boswell’s Garden Siyang’s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. While you’re here, join our Discord :) \ No newline at end of file diff --git a/indices/contentIndex.24487a624899444778bd6b11b5228c69.min.json b/indices/contentIndex.24487a624899444778bd6b11b5228c69.min.json new file mode 100644 index 000000000..db22009a6 --- /dev/null +++ b/indices/contentIndex.24487a624899444778bd6b11b5228c69.min.json @@ -0,0 +1 @@ +{"/":{"title":"πŸͺ΄ Quartz 3.2","content":"Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features\n\n1. Extremely fast full-text search by pressing `Ctrl` + `k`\n2. Customizable and hackable design based on Hugo\n3. Automatically generated backlinks, link previews, and local graph\n4. Built-in [[notes/CJK + Latex Support (ζ΅‹θ―•) | CJK + Latex Support]]\n5. Support for both Markdown Links and Wikilinks\n\n## Get Started\n\u003e πŸ“š [Setup your own digital garden using Quartz](notes/setup.md)\n\nNot convinced yet? Look at some [community digital gardens](notes/showcase.md) built with Quartz, or read about [why I made Quartz](notes/philosophy.md) to begin with.\n\n## Content Lists\nIf you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too:\n\n- [All Notes](/notes)\n- [Setup-related Notes](/tags/setup)\n\n## Troubleshooting\n- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)\n- πŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)\n- πŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t)","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95":{"title":"CJK + Latex Support (ζ΅‹θ―•)","content":"## Chinese, Japanese, Korean Support\nε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚\n\nμš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.\n\nη§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚\n\n## Latex\n\nBlock math works with two dollar signs `$$...$$`\n\n$$f(x) = \\int_{-\\infty}^\\infty\n f\\hat(\\xi),e^{2 \\pi i \\xi x}\n \\,d\\xi$$\n\t\nInline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\\pi} = 0$\n\nAligned equations work quite well:\n\n$$\n\\begin{aligned}\na \u0026= b + c \\\\ \u0026= e + f \\\\\n\\end{aligned}\n$$\n\nAnd matrices\n\n$$\n\\begin{bmatrix}\n1 \u0026 2 \u0026 3 \\\\\na \u0026 b \u0026 c\n\\end{bmatrix}\n$$\n\n## RTL\nMore information on configuring RTL languages like Arabic in the [config](notes/config.md) page.","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/config":{"title":"Configuration","content":"## Configuration\nQuartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.\n\nThe majority of configuration can be be found under `data/config.yaml`. An annotated example configuration is shown below.\n\n```yaml\nname: Your name here! # Shows in the footer\nenableToc: true # Whether to show a Table of Contents\nenableLinkPreview: true # whether to render card previews for links\ndescription: Page description to show to search engines\npage_title: Quartz Example Page # Default Page Title\n\nlinks: # Links to show in footer\n - link_name: Twitter\n link: https://twitter.com/_jzhao\n - link_name: Github\n link: https://github.com/jackyzha0\n```\n\n### Graph View\nTo customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.\n\n```yaml\nenableLegend: false # automatically generate a legend\nenableDrag: true # allow dragging nodes in the graph\nenableZoom: true # allow zooming and panning the graph\ndepth: -1 # how many neighbours of the current node to show (-1 is all nodes)\npaths: # colour specific nodes path off of their path\n - /moc: \"#4388cc\"\n```\n\n\n## Styling\nWant to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`. \n\n### Partials\nPartials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.\n\nFor example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`\n\nMore info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)\n\nStill having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n\n## Multilingual\n[CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) comes out of the box with Quartz.\n\nWant to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.\n\nFollow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml`\n\nFor example:\n\n```toml\ndefaultContentLanguage = 'ar'\n[languages]\n [languages.ar]\n languagedirection = 'rtl'\n title = 'Ω…Ψ―ΩˆΩ†Ψͺي'\n weight = 1\n```","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/custom-Domain":{"title":"Custom Domain","content":"### Registrar\nThis step is only applicable if you are using a **custom domain**! If you are using a `\u003cYOUR-USERNAME\u003e.github.io` domain, you can skip this step.\n\nFor this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).\n\nGitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to\n\n1. Go to your forked repository (`github.com/\u003cYOUR-GITHUB-USERNAME\u003e/quartz`) settings page and go to the Pages tab. Under \"Custom domain\", type your custom domain, then click **Save**.\n2. Go to your DNS Provider and create a CNAME record that points from your domain to `\u003cYOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).\n\n\t![Example Configuration for Quartz](/notes/images/google-domains.png)*Example Configuration for Quartz*\n3. Wait 30 minutes to an hour for the network changes to kick in.\n4. Done!","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/editing":{"title":"Editing Content in Quartz","content":"---\n\n## Editing \nQuartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).\n\n### Obsidian\nI recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.\n\nThis step is **highly recommended**.\n\nπŸ”— [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)\n\n### Ignoring Files\nOnly want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.\n\n❌ [Excluding pages from being published](notes/ignore%20notes.md)\n\n### Folder Structure\nHere's a rough overview of what's what.\n\n**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.\n\n**To edit the main home page, open `/content/_index.md`.*\n\nTo 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**. \n\n```markdown\nFor example, I want to link this current document to `notes/config.md`.\n[A link to the config page](notes/config.md)\n```\n\nSimilarly, you can put local images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\n### Front Matter\nHugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.\n\n```markdown","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/hosting":{"title":"Deploying Quartz to the Web","content":"---\n\n## GitHub Pages\nQuartz 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.\n\n### Enable GitHub Actions\nBy default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site!\n\n![Enable GitHub Actions](notes/images/github-actions.png)*Enable GitHub Actions*\n\n### Enable GitHub Pages\n\nHead to the 'Settings' tab of your forked repository and go to the 'Pages' tab.\n\n1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`\n2. Set a custom domain here if you have one!\n\n![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages*\n\n### Pushing Changes\nTo 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.\n\n```shell\n# Navigate to Quartz folder\ncd \u003cpath-to-quartz\u003e\n\n# Commit all changes\ngit add .\ngit commit -m \"message describing changes\"\n\n# Push to GitHub to update site\ngit push origin hugo\n```\n\nNote: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment.\n\n### Setting up the Site\nNow 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.\n\nHere, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.\n\nMake sure that your `baseURL` has a trailing `/`!\n\n[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)\n\n```toml\nbaseURL = \"https://\u003cYOUR-DOMAIN\u003e/\"\n```\n\nIf you are using this under a subdomain (e.g. `\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz`), include the trailing `/`.\n\n```toml\nbaseURL = \"https://\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz/\"\n```\n\nChange `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `\u003cYOUR-USERNAME\u003e.github.io`.\n\nPlease note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.\n\n[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)\n\n```yaml\n- name: Deploy \n uses: peaceiris/actions-gh-pages@v3 \n with: \n\tgithub_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!\n\tpublish_dir: ./public \n\tpublish_branch: master\n\tcname: \u003cYOUR-DOMAIN\u003e\n```\n\nHave a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).","lastmodified":"2022-04-06T04:41:39.05111489Z","tags":null},"/notes/ignore-notes":{"title":"Ignoring Notes","content":"---\n\n### Quartz Ignore\nEdit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered.\n\n```toml\n...\nignoreFiles = [ \n \"/content/templates/*\", \n \"/content/private/*\", \n \"\u003cyour path here\u003e\"\n]\n```\n\n`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\\\.png$`).\nTo ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note.\n\n```markdown","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/obsidian":{"title":"Obsidian Vault Integration","content":"## Setup\nObsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.\n\n### New Vault\nIf you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step.\n\n### Linking an existing Vault\nThe easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.\n\n## Settings\nGreat, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.\n\n1. Under Options \u003e Files and Links, set the New link format to always e Absolute Path in Vault.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n\n![Obsidian Settings](/notes/images/obsidian-settings.png)*Obsidian Settings*\n\n## Templates\nInserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.\n\n**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**\n\nHead over to Options \u003e Core Plugins and enable the Templates plugin. Then go to Options \u003e Hotkeys and set a hotkey for 'Insert Template' (I recomment `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/philosophy":{"title":"Quartz Philosophy","content":"\u003e β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” β€” Richard Hamming\n\n## Why Quartz?\nHosting a public digital garden isn't easy. There are an overwhelming number of tutorials, resources, and guides for tools like [Notion](https://www.notion.so/), [Roam](https://roamresearch.com/), and [Obsidian](https://obsidian.md/), yet none of them have super easy to use *free* tools to publish that garden to the world.\n\nI've personally found that\n1. It's nice to access notes from anywhere\n2. Having a public digital garden invites open conversations\n3. It makes keeping personal notes and knowledge *playful and fun*\n\nI was really inspired by [Bianca](https://garden.bianca.digital/) and [Joel](https://joelhooks.com/digital-garden)'s digital gardens and wanted to try making my own.\n\n**The goal of Quartz is to make hosting your own public digital garden free and simple.** You don't even need your own website. Quartz does all of that for you and gives your own little corner of the internet.","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/preview-changes":{"title":"Preview Changes","content":"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!\n\nNote that both of these steps need to be completed.\n\n## Install `hugo-obsidian`\nThis step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (\u003e= 1.16) installed.\n\n```shell\n# Install and link `hugo-obsidian` locally\n$ go install github.com/jackyzha0/hugo-obsidian@latest\n\n# Navigate to your local Quartz folder\n$ cd \u003clocation-of-your-local-quartz\u003e\n\n# Scrape all links in your Quartz folder and generate info for Quartz\n$ hugo-obsidian -input=content -output=assets/indices -index -root=.\n```\n\nIf 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.\n\nAfterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!\n\n## Installing Hugo\nHugo is the static site generator that powers Quartz. [Install Hugo with \"extended\" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,\n\n```\n# Navigate to your local Quartz folder\n$ cd \u003clocation-of-your-local-quartz\u003e\n\n# Start local server\n$ hugo server\n\n# View your site in a browser at http://localhost:1313/\n```","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/setup":{"title":"Setup","content":"## Making your own Quartz\nSetting up Quartz requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start!\n\n### Forking\n\u003e A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.\n\nNavigate to the GitHub repository for the Quartz project:\n\nπŸ“ [Quartz Repository](https://github.com/jackyzha0/quartz)\n\nThen, Fork the repository into your own GitHub account. If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).\n\n### Cloning\nAfter you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command replacing `YOUR-USERNAME` with your GitHub username.\n\n```shell\n$ git clone https://github.com/YOUR-USERNAME/quartz\n```\n\n## Editing\nGreat! Now you have everything you need to start editing and growing your digital garden. If you're ready to start writing content already, check out the recommended flow for editing notes in Quartz.\n\n✏️ [Editing Notes in Quartz](notes/editing.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n\n## Updating\nHaven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! \n\n```shell\nmake update\n\n# or, if you don't want the interactive parts and just want the update\nmake update-force\n```\n\nOr, manually checkout the changes yourself.\n\n\u003e ⚠️ **WARNING** ⚠️\n\u003e\n\u003e If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!\n\u003e Make sure you have a copy of these changes if you don't want to lose them.\n\n\n```shell\n# add Quartz as a remote host\ngit remote add upstream git@github.com:jackyzha0/quartz.git\n\n# index and fetch changes\ngit fetch upstream\ngit checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data \n```","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/showcase":{"title":"Showcase","content":"Want to see what Quartz can do? Here are some cool community gardens :)\n\n- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/)\n- [Jacky Zhao's Garden](https://garden.jzhao.xyz/)\n- [AWAGMI Intern Notes](https://notes.awagmi.xyz/)\n- [Shihyu's PKM](https://shihyuho.github.io/pkm/)\n- [Chloe's Garden](https://garden.chloeabrasada.online/)\n- [SlRvb's Site](https://slrvb.github.io/Site/)\n- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/)\n- [Brandon Boswell's Garden](https://brandonkboswell.com)\n- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/)\n\nIf 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/notes/showcase.md)!","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null},"/notes/troubleshooting":{"title":"Troubleshooting and FAQ","content":"Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.\n\nWhile you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)\n\n### Does Quartz have Latex support?\nYes! See [CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) for a brief demo.\n\n### Can I use \\\u003cObsidian Plugin\\\u003e in Quartz?\nUnless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.\n\nThe easiest way would be to add your own HTML partial that supports the functionality you are looking for.\n\n### My GitHub pages is just showing the README and not Quartz\nMake sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide\n\n### Some of my pages have 'January 1, 0001' as the last modified date\nThis 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.\n\n```shell\n# in the root of your Quartz (same folder as config.toml)\ngit config core.ignorecase true\n\n# or globally (not recommended)\ngit config --global core.ignorecase true\n```\n\n### Can I publish only a subset of my pages?\nYes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore%20notes.md).\n\n### Can I host this myself and not on GitHub Pages?\nYes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).\n\n### `command not found: hugo-obsidian`\nMake sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.\n\n```shell\n# Add the following 2 lines to your ~/.bash_profile\nexport GOPATH=/Users/$USER/go\nexport PATH=$GOPATH/bin:$PATH\n\n# In your current terminal, to reload the session\nsource ~/.bash_profile\n```\n\n### How come my notes aren't being rendered?\nYou probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md).\n\n### My custom domain isn't working!\nWalk through the steps in [the hosting guide](notes/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.\n\n### How do I setup Google Analytics?\nYou can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.\n\n### How do I change the content on the home page?\nTo edit the main home page, open `/content/_index.md`.\n\n### How do I change the colours?\nYou can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md).\n\n### How do I add images?\nYou can put images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\n### My Interactive Graph and Backlinks aren't up to date\nBy default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md)\n\n### Can I use React/Vue/some other framework?\nNot out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.\n\n## Still Stuck?\nQuartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can.\n\nπŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)","lastmodified":"2022-04-06T04:41:39.055115078Z","tags":null}} \ No newline at end of file diff --git a/indices/contentIndex.43ffc7c634131ced04be95e1e589da2b.min.json b/indices/contentIndex.43ffc7c634131ced04be95e1e589da2b.min.json deleted file mode 100644 index df11abc0d..000000000 --- a/indices/contentIndex.43ffc7c634131ced04be95e1e589da2b.min.json +++ /dev/null @@ -1 +0,0 @@ -{"/":{"title":"πŸͺ΄ Quartz 3.2","content":"Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features\n\n1. Extremely fast full-text search by pressing `Ctrl` + `k`\n2. Customizable and hackable design based on Hugo\n3. Automatically generated backlinks, link previews, and local graph\n4. Built-in [[notes/CJK + Latex Support (ζ΅‹θ―•) | CJK + Latex Support]]\n5. Support for both Markdown Links and Wikilinks\n\n## Get Started\n\u003e πŸ“š [Setup your own digital garden using Quartz](notes/setup.md)\n\nNot convinced yet? Look at some [community digital gardens](notes/showcase.md) built with Quartz, or read about [why I made Quartz](notes/philosophy.md) to begin with.\n\n## Content Lists\nIf you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too:\n\n- [All Notes](/notes)\n- [Setup-related Notes](/tags/setup)\n\n## Troubleshooting\n- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)\n- πŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)\n- πŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t)","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95":{"title":"CJK + Latex Support (ζ΅‹θ―•)","content":"## Chinese, Japanese, Korean Support\nε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚\n\nμš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.\n\nη§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚\n\n## Latex\n\nBlock math works with two dollar signs `$$...$$`\n\n$$f(x) = \\int_{-\\infty}^\\infty\n f\\hat(\\xi),e^{2 \\pi i \\xi x}\n \\,d\\xi$$\n\t\nInline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\\pi} = 0$\n\nAligned equations work quite well:\n\n$$\n\\begin{aligned}\na \u0026= b + c \\\\ \u0026= e + f \\\\\n\\end{aligned}\n$$\n\nAnd matrices\n\n$$\n\\begin{bmatrix}\n1 \u0026 2 \u0026 3 \\\\\na \u0026 b \u0026 c\n\\end{bmatrix}\n$$\n\n## RTL\nMore information on configuring RTL languages like Arabic in the [config](notes/config.md) page.","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/config":{"title":"Configuration","content":"## Configuration\nQuartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.\n\nThe majority of configuration can be be found under `data/config.yaml`. An annotated example configuration is shown below.\n\n```yaml\nname: Your name here! # Shows in the footer\nenableToc: true # Whether to show a Table of Contents\nenableLinkPreview: true # whether to render card previews for links\ndescription: Page description to show to search engines\npage_title: Quartz Example Page # Default Page Title\n\nlinks: # Links to show in footer\n - link_name: Twitter\n link: https://twitter.com/_jzhao\n - link_name: Github\n link: https://github.com/jackyzha0\n```\n\n### Graph View\nTo customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.\n\n```yaml\nenableLegend: false # automatically generate a legend\nenableDrag: true # allow dragging nodes in the graph\nenableZoom: true # allow zooming and panning the graph\ndepth: -1 # how many neighbours of the current node to show (-1 is all nodes)\npaths: # colour specific nodes path off of their path\n - /moc: \"#4388cc\"\n```\n\n\n## Styling\nWant to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`. \n\n### Partials\nPartials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.\n\nFor example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`\n\nMore info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)\n\nStill having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n\n## Multilingual\n[CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) comes out of the box with Quartz.\n\nWant to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.\n\nFollow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml`\n\nFor example:\n\n```toml\ndefaultContentLanguage = 'ar'\n[languages]\n [languages.ar]\n languagedirection = 'rtl'\n title = 'Ω…Ψ―ΩˆΩ†Ψͺي'\n weight = 1\n```","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/custom-Domain":{"title":"Custom Domain","content":"### Registrar\nThis step is only applicable if you are using a **custom domain**! If you are using a `\u003cYOUR-USERNAME\u003e.github.io` domain, you can skip this step.\n\nFor this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).\n\nGitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to\n\n1. Go to your forked repository (`github.com/\u003cYOUR-GITHUB-USERNAME\u003e/quartz`) settings page and go to the Pages tab. Under \"Custom domain\", type your custom domain, then click **Save**.\n2. Go to your DNS Provider and create a CNAME record that points from your domain to `\u003cYOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).\n\n\t![Example Configuration for Quartz](/notes/images/google-domains.png)*Example Configuration for Quartz*\n3. Wait 30 minutes to an hour for the network changes to kick in.\n4. Done!","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/editing":{"title":"Editing Content in Quartz","content":"---\n\n## Editing \nQuartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).\n\n### Obsidian\nI recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.\n\nThis step is **highly recommended**.\n\nπŸ”— [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)\n\n### Ignoring Files\nOnly want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.\n\n❌ [Excluding pages from being published](notes/ignore%20notes.md)\n\n### Folder Structure\nHere's a rough overview of what's what.\n\n**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.\n\n**To edit the main home page, open `/content/_index.md`.*\n\nTo 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**. \n\n```markdown\nFor example, I want to link this current document to `notes/config.md`.\n[A link to the config page](notes/config.md)\n```\n\nSimilarly, you can put local images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\n### Front Matter\nHugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.\n\n```markdown","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/hosting":{"title":"Deploying Quartz to the Web","content":"---\n\n## GitHub Pages\nQuartz 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.\n\n### Enable GitHub Actions\nBy default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site!\n\n![Enable GitHub Actions](notes/images/github-actions.png)*Enable GitHub Actions*\n\n### Enable GitHub Pages\n\nHead to the 'Settings' tab of your forked repository and go to the 'Pages' tab.\n\n1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`\n2. Set a custom domain here if you have one!\n\n![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages*\n\n### Pushing Changes\nTo 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.\n\n```shell\n# Navigate to Quartz folder\ncd \u003cpath-to-quartz\u003e\n\n# Commit all changes\ngit add .\ngit commit -m \"message describing changes\"\n\n# Push to GitHub to update site\ngit push origin hugo\n```\n\nNote: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment.\n\n### Setting up the Site\nNow 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.\n\nHere, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.\n\nMake sure that your `baseURL` has a trailing `/`!\n\n[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)\n\n```toml\nbaseURL = \"https://\u003cYOUR-DOMAIN\u003e/\"\n```\n\nIf you are using this under a subdomain (e.g. `\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz`), include the trailing `/`.\n\n```toml\nbaseURL = \"https://\u003cYOUR-GITHUB-USERNAME\u003e.github.io/quartz/\"\n```\n\nChange `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `\u003cYOUR-USERNAME\u003e.github.io`.\n\nPlease note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.\n\n[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)\n\n```yaml\n- name: Deploy \n uses: peaceiris/actions-gh-pages@v3 \n with: \n\tgithub_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!\n\tpublish_dir: ./public \n\tpublish_branch: master\n\tcname: \u003cYOUR-DOMAIN\u003e\n```\n\nHave a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/ignore-notes":{"title":"Ignoring Notes","content":"---\n\n### Quartz Ignore\nEdit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered.\n\n```toml\n...\nignoreFiles = [ \n \"/content/templates/*\", \n \"/content/private/*\", \n \"\u003cyour path here\u003e\"\n]\n```\n\n`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\\\.png$`).\nTo ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note.\n\n```markdown","lastmodified":"2022-04-06T03:45:14.873548881Z","tags":null},"/notes/obsidian":{"title":"Obsidian Vault Integration","content":"## Setup\nObsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.\n\n### New Vault\nIf you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step.\n\n### Linking an existing Vault\nThe easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.\n\n## Settings\nGreat, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.\n\n1. Under Options \u003e Files and Links, set the New link format to always e Absolute Path in Vault.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n\n![Obsidian Settings](/notes/images/obsidian-settings.png)*Obsidian Settings*\n\n## Templates\nInserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.\n\n**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**\n\nHead over to Options \u003e Core Plugins and enable the Templates plugin. Then go to Options \u003e Hotkeys and set a hotkey for 'Insert Template' (I recomment `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null},"/notes/philosophy":{"title":"Quartz Philosophy","content":"\u003e β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” β€” Richard Hamming\n\n## Why Quartz?\nHosting a public digital garden isn't easy. There are an overwhelming number of tutorials, resources, and guides for tools like [Notion](https://www.notion.so/), [Roam](https://roamresearch.com/), and [Obsidian](https://obsidian.md/), yet none of them have super easy to use *free* tools to publish that garden to the world.\n\nI've personally found that\n1. It's nice to access notes from anywhere\n2. Having a public digital garden invites open conversations\n3. It makes keeping personal notes and knowledge *playful and fun*\n\nI was really inspired by [Bianca](https://garden.bianca.digital/) and [Joel](https://joelhooks.com/digital-garden)'s digital gardens and wanted to try making my own.\n\n**The goal of Quartz is to make hosting your own public digital garden free and simple.** You don't even need your own website. Quartz does all of that for you and gives your own little corner of the internet.","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null},"/notes/preview-changes":{"title":"Preview Changes","content":"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!\n\nNote that both of these steps need to be completed.\n\n## Install `hugo-obsidian`\nThis step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (\u003e= 1.16) installed.\n\n```shell\n# Install and link `hugo-obsidian` locally\n$ go install github.com/jackyzha0/hugo-obsidian@latest\n\n# Navigate to your local Quartz folder\n$ cd \u003clocation-of-your-local-quartz\u003e\n\n# Scrape all links in your Quartz folder and generate info for Quartz\n$ hugo-obsidian -input=content -output=assets/indices -index -root=.\n```\n\nIf 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.\n\nAfterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!\n\n## Installing Hugo\nHugo is the static site generator that powers Quartz. [Install Hugo with \"extended\" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,\n\n```\n# Navigate to your local Quartz folder\n$ cd \u003clocation-of-your-local-quartz\u003e\n\n# Start local server\n$ hugo server\n\n# View your site in a browser at http://localhost:1313/\n```","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null},"/notes/setup":{"title":"Setup","content":"## Making your own Quartz\nSetting up Quartz requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start!\n\n### Forking\n\u003e A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.\n\nNavigate to the GitHub repository for the Quartz project:\n\nπŸ“ [Quartz Repository](https://github.com/jackyzha0/quartz)\n\nThen, Fork the repository into your own GitHub account. If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).\n\n### Cloning\nAfter you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command replacing `YOUR-USERNAME` with your GitHub username.\n\n```shell\n$ git clone https://github.com/YOUR-USERNAME/quartz\n```\n\n## Editing\nGreat! Now you have everything you need to start editing and growing your digital garden. If you're ready to start writing content already, check out the recommended flow for editing notes in Quartz.\n\n✏️ [Editing Notes in Quartz](notes/editing.md)\n\nHaving problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).\n\n## Updating\nHaven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! \n\n```shell\nmake update\n\n# or, if you don't want the interactive parts and just want the update\nmake update-force\n```\n\nOr, manually checkout the changes yourself.\n\n\u003e ⚠️ **WARNING** ⚠️\n\u003e\n\u003e If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!\n\u003e Make sure you have a copy of these changes if you don't want to lose them.\n\n\n```shell\n# add Quartz as a remote host\ngit remote add upstream git@github.com:jackyzha0/quartz.git\n\n# index and fetch changes\ngit fetch upstream\ngit checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data \n```","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null},"/notes/showcase":{"title":"Showcase","content":"Want to see what Quartz can do? Here are some cool community gardens :)\n\n- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/)\n- [Strengthening Online Social Bonds: Research Garden](https://communities.digital/)\n- [Jacky Zhao's Garden](https://garden.jzhao.xyz/)\n- [Anson Yu's Garden](http://garden.ansonyu.me/)\n- [Shihyu's PKM](https://shihyuho.github.io/pkm/)\n- [Chloe's Garden](https://garden.chloeabrasada.online/)\n- [SlRvb's Site](https://slrvb.github.io/Site/)\n- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/)\n- [Brandon Boswell's Garden](https://brandonkboswell.com)\n- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/)\n\nIf 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/notes/showcase.md)!","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null},"/notes/troubleshooting":{"title":"Troubleshooting and FAQ","content":"Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.\n\nWhile you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)\n\n### Does Quartz have Latex support?\nYes! See [CJK + Latex Support (ζ΅‹θ―•)](notes/CJK%20+%20Latex%20Support%20(ζ΅‹θ―•).md) for a brief demo.\n\n### Can I use \\\u003cObsidian Plugin\\\u003e in Quartz?\nUnless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.\n\nThe easiest way would be to add your own HTML partial that supports the functionality you are looking for.\n\n### My GitHub pages is just showing the README and not Quartz\nMake sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide\n\n### Some of my pages have 'January 1, 0001' as the last modified date\nThis 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.\n\n```shell\n# in the root of your Quartz (same folder as config.toml)\ngit config core.ignorecase true\n\n# or globally (not recommended)\ngit config --global core.ignorecase true\n```\n\n### Can I publish only a subset of my pages?\nYes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore%20notes.md).\n\n### Can I host this myself and not on GitHub Pages?\nYes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).\n\n### `command not found: hugo-obsidian`\nMake sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.\n\n```shell\n# Add the following 2 lines to your ~/.bash_profile\nexport GOPATH=/Users/$USER/go\nexport PATH=$GOPATH/bin:$PATH\n\n# In your current terminal, to reload the session\nsource ~/.bash_profile\n```\n\n### How come my notes aren't being rendered?\nYou probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md).\n\n### My custom domain isn't working!\nWalk through the steps in [the hosting guide](notes/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.\n\n### How do I setup Google Analytics?\nYou can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.\n\n### How do I change the content on the home page?\nTo edit the main home page, open `/content/_index.md`.\n\n### How do I change the colours?\nYou can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md).\n\n### How do I add images?\nYou can put images anywhere in the `/content` folder.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n![Example Image](/content/notes/images/example.png)\n```\n\n### My Interactive Graph and Backlinks aren't up to date\nBy default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md)\n\n### Can I use React/Vue/some other framework?\nNot out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.\n\n## Still Stuck?\nQuartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can.\n\nπŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues)","lastmodified":"2022-04-06T03:45:14.877548888Z","tags":null}} \ No newline at end of file diff --git a/js/darkmode.46b07878b7f5d9e26ad7a3c40f8a0605.min.js b/js/darkmode.46b07878b7f5d9e26ad7a3c40f8a0605.min.js index 3afe7d105..251dd3366 100644 --- a/js/darkmode.46b07878b7f5d9e26ad7a3c40f8a0605.min.js +++ b/js/darkmode.46b07878b7f5d9e26ad7a3c40f8a0605.min.js @@ -1 +1 @@ -const userPref=window.matchMedia('(prefers-color-scheme: light)').matches?'light':'dark',currentTheme=localStorage.getItem('theme')??userPref;currentTheme&&document.documentElement.setAttribute('saved-theme',currentTheme);const switchTheme=a=>{a.target.checked?(document.documentElement.setAttribute('saved-theme','dark'),localStorage.setItem('theme','dark')):(document.documentElement.setAttribute('saved-theme','light'),localStorage.setItem('theme','light'))};window.addEventListener('DOMContentLoaded',()=>{const a=document.querySelector('#darkmode-toggle');a.addEventListener('change',switchTheme,!1),currentTheme==='dark'&&(a.checked=!0)}) \ No newline at end of file +const userPref=window.matchMedia("(prefers-color-scheme: light)").matches?"light":"dark",currentTheme=localStorage.getItem("theme")??userPref;currentTheme&&document.documentElement.setAttribute("saved-theme",currentTheme);const switchTheme=e=>{e.target.checked?(document.documentElement.setAttribute("saved-theme","dark"),localStorage.setItem("theme","dark")):(document.documentElement.setAttribute("saved-theme","light"),localStorage.setItem("theme","light"))};window.addEventListener("DOMContentLoaded",()=>{const e=document.querySelector("#darkmode-toggle");e.addEventListener("change",switchTheme,!1),currentTheme==="dark"&&(e.checked=!0)}) \ No newline at end of file diff --git a/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js b/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js index 26bfe6576..2575c425c 100644 --- a/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js +++ b/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js @@ -1,5 +1,5 @@ -function htmlToElement(a){const b=document.createElement('template');return a=a.trim(),b.innerHTML=a,b.content.firstChild}function initPopover(a){const b=a.replace(window.location.origin,"");document.addEventListener("DOMContentLoaded",()=>{fetchData.then(({content:a})=>{const c=[...document.getElementsByClassName("internal-link")];c.filter(a=>a.dataset.src).forEach(c=>{const d=a[c.dataset.src.replace(b,"")];if(d){const b=`
-

${d.title}

-

${removeMarkdown(d.content).split(" ",20).join(" ")}...

-

${new Date(d.lastmodified).toLocaleDateString()}

-
`,a=htmlToElement(b);c.appendChild(a),c.addEventListener("mouseover",()=>{a.classList.add("visible")}),c.addEventListener("mouseout",()=>{a.classList.remove("visible")})}})})})} \ No newline at end of file +function htmlToElement(e){const t=document.createElement("template");return e=e.trim(),t.innerHTML=e,t.content.firstChild}function initPopover(e){const t=e.replace(window.location.origin,"");document.addEventListener("DOMContentLoaded",()=>{fetchData.then(({content:e})=>{const n=[...document.getElementsByClassName("internal-link")];n.filter(e=>e.dataset.src).forEach(n=>{const s=e[n.dataset.src.replace(t,"")];if(s){const t=`
+

${s.title}

+

${removeMarkdown(s.content).split(" ",20).join(" ")}...

+

${new Date(s.lastmodified).toLocaleDateString()}

+
`,e=htmlToElement(t);n.appendChild(e),n.addEventListener("mouseover",()=>{e.classList.add("visible")}),n.addEventListener("mouseout",()=>{e.classList.remove("visible")})}})})})} \ No newline at end of file diff --git a/js/search.bc849b857f2c1b822264d40635bb67b6.min.js b/js/search.bc849b857f2c1b822264d40635bb67b6.min.js index c45165d1d..7e6171121 100644 --- a/js/search.bc849b857f2c1b822264d40635bb67b6.min.js +++ b/js/search.bc849b857f2c1b822264d40635bb67b6.min.js @@ -1,7 +1,7 @@ -const removeMarkdown=(c,b={listUnicodeChar:!1,stripListLeaders:!0,gfm:!0,useImgAltText:!1,preserveLinks:!1})=>{let a=c||"";a=a.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm,"");try{b.stripListLeaders&&(b.listUnicodeChar?a=a.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm,b.listUnicodeChar+" $1"):a=a.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm,"$1")),b.gfm&&(a=a.replace(/\n={2,}/g,"\n").replace(/~{3}.*\n/g,"").replace(/~~/g,"").replace(/`{3}.*\n/g,"")),b.preserveLinks&&(a=a.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g,"$1 ($2)")),a=a.replace(/<[^>]*>/g,"").replace(/^[=\-]{2,}\s*$/g,"").replace(/\[\^.+?\](\: .*?$)?/g,"").replace(/\s{0,2}\[.*?\]: .*?$/g,"").replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g,b.useImgAltText?"$1":"").replace(/\[(.*?)\][\[\(].*?[\]\)]/g,"$1").replace(/^\s{0,3}>\s?/g,"").replace(/(^|\n)\s{0,3}>\s?/g,"\n\n").replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g,"").replace(/^(\n)?\s{0,}#{1,6}\s+| {0,}(\n)?\s{0,}#{0,} {0,}(\n)?\s{0,}$/gm,"$1$2$3").replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g,"$2").replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g,"$2").replace(/(`{3,})(.*?)\1/gm,"$2").replace(/`(.+?)`/g,"$1").replace(/\n{2,}/g,"\n\n")}catch(a){return console.error(a),c}return a};(async function(){const g=a=>a.toLowerCase().split(/([^a-z]|[^\x00-\x7F])+/),k=new FlexSearch.Document({cache:!0,charset:"latin:extra",optimize:!0,index:[{field:"content",tokenize:"reverse",encode:g},{field:"title",tokenize:"forward",encode:g}]}),{content:e}=await fetchData;for(const[b,a]of Object.entries(e))k.add({id:b,title:a.title,content:removeMarkdown(a.content)});const j=(i,j)=>{const a=20,k=j.split(/\s+/).filter(a=>a!==""),b=i.split(/\s+/).filter(a=>a!==""),f=a=>k.some(b=>a.toLowerCase().startsWith(b.toLowerCase())),d=b.map(f);let e=0,g=0;for(let b=0;ba+b,0);c>=e&&(e=c,g=b)}const c=Math.max(g-a,0),h=Math.min(c+2*a,b.length),l=b.slice(c,h).map(a=>f(a)?`${a}`:a).join(" ").replaceAll(' '," ");return`${c===0?"":"..."}${l}${h===b.length?"":"..."}`},n=({url:b,title:c,content:d,term:a})=>{const e=removeMarkdown(d),f=j(c,a),g=j(e,a);return``},h=(a,b)=>{window.location.href=BASE_URL+`${a}#:~:text=${encodeURIComponent(b)}`},m=a=>({id:a,url:a,title:e[a].title,content:e[a].content}),c=document.getElementById('search-bar'),f=document.getElementById("results-container");let b;c.addEventListener("keyup",a=>{if(a.key==="Enter"){const a=document.getElementsByClassName("result-card")[0];h(a.id,b)}}),c.addEventListener('input',d=>{b=d.target.value;const e=k.search(b,[{field:"content",limit:10},{field:"title",limit:5}]),a=b=>{const a=e.filter(a=>a.field===b);return a.length===0?[]:[...a[0].result]},g=new Set([...a('title'),...a('content')]),c=[...g].map(m);if(c.length===0)f.innerHTML=``},r=(e,t)=>{window.location.href=BASE_URL+`${e}#:~:text=${encodeURIComponent(t)}`},h=e=>({id:e,url:e,title:o[e].title,content:o[e].content}),n=document.getElementById("search-bar"),i=document.getElementById("results-container");let t;n.addEventListener("keyup",e=>{if(e.key==="Enter"){const e=document.getElementsByClassName("result-card")[0];r(e.id,t)}}),n.addEventListener("input",s=>{t=s.target.value;const o=d.search(t,[{field:"content",limit:10},{field:"title",limit:5}]),e=t=>{const e=o.filter(e=>e.field===t);return e.length===0?[]:[...e[0].result]},a=new Set([...e("title"),...e("content")]),n=[...a].map(h);if(n.length===0)i.innerHTML=``;else{f.innerHTML=c.map(a=>n({...a,term:b})).join("\n");const a=document.getElementsByClassName("result-card");[...a].forEach(a=>{a.onclick=()=>h(a.id,b)})}});const a=document.getElementById("search-container");function d(){a.style.display==="none"||a.style.display===""?(c.value="",f.innerHTML="",a.style.display="block",c.focus()):a.style.display="none"}function i(){a.style.display="none"}document.addEventListener('keydown',a=>{a.key==="k"&&(a.ctrlKey||a.metaKey)&&(a.preventDefault(),d()),a.key==="Escape"&&(a.preventDefault(),i())});const l=document.getElementById("search-icon");l.addEventListener('click',a=>{d()}),l.addEventListener('keydown',a=>{d()}),a.addEventListener('click',a=>{i()}),document.getElementById("search-space").addEventListener('click',a=>{a.stopPropagation()})})() \ No newline at end of file + `;else{i.innerHTML=n.map(e=>m({...e,term:t})).join("\n");const e=document.getElementsByClassName("result-card");[...e].forEach(e=>{e.onclick=()=>r(e.id,t)})}});const e=document.getElementById("search-container");function s(){e.style.display==="none"||e.style.display===""?(n.value="",i.innerHTML="",e.style.display="block",n.focus()):e.style.display="none"}function c(){e.style.display="none"}document.addEventListener("keydown",e=>{e.key==="k"&&(e.ctrlKey||e.metaKey)&&(e.preventDefault(),s()),e.key==="Escape"&&(e.preventDefault(),c())});const u=document.getElementById("search-icon");u.addEventListener("click",e=>{s()}),u.addEventListener("keydown",e=>{s()}),e.addEventListener("click",e=>{c()}),document.getElementById("search-space").addEventListener("click",e=>{e.stopPropagation()})})() \ No newline at end of file diff --git a/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html b/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html index 1c67a2b20..50a606115 100644 --- a/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html +++ b/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html @@ -1,113 +1,22 @@ - - - - -CJK + Latex Support (ζ΅‹θ―•) - - - - - - - +Latex Block math works with two dollar signs $$.">CJK + Latex Support (ζ΅‹θ―•) + - - - - - - -
-
- -
-
-
-
- - -
-
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search -
-
- - - -
-
-
-

CJK + Latex Support (ζ΅‹θ―•)

-

-Last updated Unknown -

-
    -
-

Chinese, Japanese, Korean Support

-

ε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚

-

μš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.

-

η§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚

-

Latex

-

Block math works with two dollar signs $$...$$

-

$$f(x) = \int_{-\infty}^\infty + +

+

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

CJK + Latex Support (ζ΅‹θ―•)

Last updated Unknown

    Chinese, Japanese, Korean Support

    ε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚

    μš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€.

    η§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚

    Latex

    Block math works with two dollar signs $$...$$

    $$f(x) = \int_{-\infty}^\infty f\hat(\xi),e^{2 \pi i \xi x} -,d\xi$$

    -

    Inline math also works with single dollar signs $...$. For example, Euler’s identity but inline: $e^{i\pi} = 0$

    -

    Aligned equations work quite well:

    -

    $$ +,d\xi$$

    Inline math also works with single dollar signs $...$. For example, Euler’s identity but inline: $e^{i\pi} = 0$

    Aligned equations work quite well:

    $$ \begin{aligned} a &= b + c \\&= e + f \\\end{aligned} -$$

    -

    And matrices

    -

    $$ +$$

    And matrices

    $$ \begin{bmatrix} 1 & 2 & 3 \\a & b & c \end{bmatrix} -$$

    -

    RTL

    -

    More information on configuring RTL languages like Arabic in the -config page.

    -
    -
    -
    -
    -

    Backlinks

    - -
    -
    - -

    Interactive Graph

    -
    - - - -
    -
    -
    - -
    - - -
    - - \ No newline at end of file +$$

    RTL

    More information on configuring RTL languages like Arabic in the +config page.

    Backlinks

    Interactive Graph

    +
    +
    \ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index b597a6dd4..295090700 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,77 +1,10 @@ - - - - -Configuration - - - - - - - +Configuration + - - - - - - -
    -
    - -
    -
    -
    -
    - - -
    -
    -

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search -
    -
    - - - -
    -
    -
    -

    Configuration

    -

    -Last updated April 5, 2022 -

    - - -

    Configuration

    -

    Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get.

    -

    The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.

    -
    -
    -
     1
+
+
    
+
    πŸͺ΄ Quartz 3.2
    Search IconIcon to open search
    
+
    Configuration
    Last updated April 5, 2022
    Configuration
    Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get.
    The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.
    
-
     1
  2
  3
  4
@@ -82,112 +15,44 @@ Last updated April 5, 2022
  9
 10
 11
-
    		
-
    name: Your name here! # Shows in the footer
-enableToc: true # Whether to show a Table of Contents
-enableLinkPreview: true # whether to render card previews for links
-description: Page description to show to search engines
-page_title: Quartz Example Page # Default Page Title
-
-links: # Links to show in footer
-  - link_name: Twitter
-    link: https://twitter.com/_jzhao
-  - link_name: Github
-    link: https://github.com/jackyzha0
-
    
-
    
-
    Graph View
    
-
    To customize the Interactive Graph view, you can poke around data/graphConfig.yaml.
    
-
    
-
    
-
    1
+
    name: Your name here! # Shows in the footer
+enableToc: true # Whether to show a Table of Contents
+enableLinkPreview: true # whether to render card previews for links
+description: Page description to show to search engines
+page_title: Quartz Example Page # Default Page Title
+
+links: # Links to show in footer
+  - link_name: Twitter
+    link: https://twitter.com/_jzhao
+  - link_name: Github
+    link: https://github.com/jackyzha0
+
    Graph View
    To customize the Interactive Graph view, you can poke around data/graphConfig.yaml.
    
-
    1
 2
 3
 4
 5
 6
-
    		
-
    enableLegend: false # automatically generate a legend
-enableDrag: true # allow dragging nodes in the graph
-enableZoom: true # allow zooming and panning the graph
-depth: -1 # how many neighbours of the current node to show (-1 is all nodes)
-paths: # colour specific nodes path off of their path
-  - /moc: "#4388cc"
-
    
-
    
-
    Styling
    
-
    Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing assets/styles/custom.scss. If you’d like to target specific parts of the site, you can add ids and classes to the HTML partials in /layouts/partials.
    
-
    Partials
    
-
    Partials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in /layouts.
    
-
    For example, the structure of the home page can be edited through /layouts/index.html. To customize the footer, you can edit /layouts/partials/footer.html
    
-
    More info about partials on
-Hugo’s website.
    
-
    Still having problems? Checkout our
-FAQ and Troubleshooting guide.
    
-
    Multilingual
    
-
    
-CJK + Latex Support (ζ΅‹θ―•) comes out of the box with Quartz.
    
-
    Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.
    
-
    Follow the steps
-Hugo provides here and modify your config.toml
    
-
    For example:
    
-
    
-
    
-
    1
+
    enableLegend: false # automatically generate a legend
+enableDrag: true # allow dragging nodes in the graph
+enableZoom: true # allow zooming and panning the graph
+depth: -1 # how many neighbours of the current node to show (-1 is all nodes)
+paths: # colour specific nodes path off of their path
+  - /moc: "#4388cc"
+
    Styling
    Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing assets/styles/custom.scss. If you’d like to target specific parts of the site, you can add ids and classes to the HTML partials in /layouts/partials.
    Partials
    Partials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in /layouts.
    For example, the structure of the home page can be edited through /layouts/index.html. To customize the footer, you can edit /layouts/partials/footer.html
    More info about partials on
+Hugo’s website.
    Still having problems? Checkout our
+FAQ and Troubleshooting guide.
    Multilingual
    CJK + Latex Support (ζ΅‹θ―•) comes out of the box with Quartz.
    Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.
    Follow the steps
+Hugo provides here and modify your config.toml
    For example:
    
-
    1
 2
 3
 4
 5
 6
-
    		
-
    defaultContentLanguage = 'ar'
-[languages]
-  [languages.ar]
-    languagedirection = 'rtl'
-    title = 'Ω…Ψ―ΩˆΩ†Ψͺي'
-    weight = 1
-
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Backlinks
    
-
-
    
-
    
-
-
    Interactive Graph
    
-
    
-
-
-
-
    
-
    
-
    
-
-
    
-
-
-
    
-
-
\ No newline at end of file
+
    defaultContentLanguage = 'ar'
+[languages]
+  [languages.ar]
+    languagedirection = 'rtl'
+    title = 'Ω…Ψ―ΩˆΩ†Ψͺي'
+    weight = 1
+

    Backlinks

    Interactive Graph

    +
    +
    \ No newline at end of file diff --git a/notes/custom-Domain/index.html b/notes/custom-Domain/index.html index 4ecf80dac..21b95ec11 100644 --- a/notes/custom-Domain/index.html +++ b/notes/custom-Domain/index.html @@ -1,101 +1,10 @@ - - - - -Custom Domain - - - - - - - +Custom Domain + - - - - - - -
    -
    - -
    -
    -
    -
    - - -
    -
    -

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search -
    -
    - - - -
    -
    -
    -

    Custom Domain

    -

    -Last updated April 5, 2022 -

    -
      -
    -

    Registrar

    -

    This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step.

    -

    For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).

    -

    GitHub has some -documentation on this, but the tldr; is to

    -
      -
    1. -

      Go to your forked repository (github.com/<YOUR-GITHUB-USERNAME>/quartz) settings page and go to the Pages tab. Under “Custom domain”, type your custom domain, then click Save.

      -
      2. -
    2. -

      Go to your DNS Provider and create a CNAME record that points from your domain to <YOUR-GITHUB-USERNAME.github.io. (yes, with the trailing period).

      -

      -Example Configuration for QuartzExample Configuration for Quartz

      -
      3. -
    3. -

      Wait 30 minutes to an hour for the network changes to kick in.

      -
      4. -
    4. -

      Done!

      -
      5. -
    -
    -
    -
    -
    -

    Backlinks

    - -
    -
    - -

    Interactive Graph

    -
    - - - -
    -
    -
    - -
    - - -
    - - \ No newline at end of file + +
    +

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search
    +

    Custom Domain

    Last updated April 5, 2022

      Registrar

      This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step.

      For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).

      GitHub has some +documentation on this, but the tldr; is to

      1. Go to your forked repository (github.com/<YOUR-GITHUB-USERNAME>/quartz) settings page and go to the Pages tab. Under “Custom domain”, type your custom domain, then click Save.

      2. Go to your DNS Provider and create a CNAME record that points from your domain to <YOUR-GITHUB-USERNAME.github.io. (yes, with the trailing period).

        Example Configuration for QuartzExample Configuration for Quartz

      3. Wait 30 minutes to an hour for the network changes to kick in.

      4. Done!

      Backlinks

      Interactive Graph

      +
      +
      \ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index c249bbb39..20173aa04 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,116 +1,24 @@ - - - - -Editing Content in Quartz - - - - - - - +Editing Content in Quartz + - - - - - - -
      -
      - -
      -
      -
      -
      - - -
      -
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search -
      -
      - - - -
      -
      -
      -

      Editing Content in Quartz

      -

      -Last updated April 5, 2022 -

      - - -

      Editing

      -

      Quartz runs on top of + +

      +

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search
      +

      Editing Content in Quartz

      Last updated April 5, 2022

      Editing

      Quartz runs on top of Hugo so all notes are written in -Markdown.

      -

      Obsidian

      -

      I recommend using -Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.

      -

      This step is highly recommended.

      -

      πŸ”— -How to setup your Obsidian Vault to work with Quartz

      -

      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

      -

      Folder Structure

      -

      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.

      -

      *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.

      -
      -
      -
      1
+Markdown.
      Obsidian
      I recommend using
+Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.
      This step is highly recommended.
      πŸ”—
+How to setup your Obsidian Vault to work with Quartz
      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
      Folder Structure
      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.
      *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.
      
-
      1
 2
-
      		
-
      For example, I want to link this current document to `notes/config.md`.
-[A link to the config page](notes/config.md)
-
      
-
      
-
      Similarly, you can put local images anywhere in the /content folder.
      
-
      
-
      
-
      1
+
      For example, I want to link this current document to `notes/config.md`.
+[A link to the config page](notes/config.md)
+
      Similarly, you can put local images anywhere in the /content folder.
      
-
      1
 2
-
      		
-
      Example image (source is in content/notes/images/example.png)
-![Example Image](/content/notes/images/example.png)
-
      
-
      
-
      Front Matter
      
-
      Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.
      
-
      
-
      
-
      1
+
      Example image (source is in content/notes/images/example.png)
+![Example Image](/content/notes/images/example.png)
+
      Front Matter
      Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.
      
-
      1
 2
 3
 4
@@ -118,62 +26,17 @@ Last updated April 5, 2022
 6
 7
 8
-
      		
-
      ---
-title: "Example Title"
-tags:
-- example-tag
-enableToc: false # do not show a table of contents on this page
----
-
-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. This is highly recommended but not required.
      
-
      πŸ‘€
-Preview Quartz Changes
      
-
      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!
      
-
      🌍
-Hosting Quartz online!
      
-
      Having problems? Checkout our
-FAQ and Troubleshooting guide.
      
-
-
      
-
      
-
      
-
      Backlinks
      
-
-
      
-
      
-
-
      Interactive Graph
      
-
      
-
-
-
-
      
-
      
-
      
-
-
      
-
-
-
-
-
\ No newline at end of file
+
      ---
+title: "Example Title"
+tags:
+- example-tag
+enableToc: false # do not show a table of contents on this page
+---
+
+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. This is highly recommended but not required.

      πŸ‘€ +Preview Quartz Changes

      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!

      🌍 +Hosting Quartz online!

      Having problems? Checkout our +FAQ and Troubleshooting guide.

      Backlinks

      Interactive Graph

      +
      +
      \ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html index 5ef1512d0..c779a1d87 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,87 +1,10 @@ - - - - -Deploying Quartz to the Web - - - - - - - +Deploying Quartz to the Web + - - - - - - -
      -
      - -
      -
      -
      -
      - - -
      -
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search -
      -
      - - - -
      -
      -
      -

      Deploying Quartz to the Web

      -

      -Last updated April 5, 2022 -

      - - -

      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

      -

      By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the ‘Actions’ tab of your forked repository and Enable Workflows to setup deploying your Quartz site!

      -

      -Enable GitHub ActionsEnable GitHub Actions

      -

      Enable GitHub Pages

      -

      Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.

      -
        -
      1. (IMPORTANT) Set the source to deploy from master (and not hugo) using / (root)
        2. -
      2. Set a custom domain here if you have one!
        3. -
      -

      -Enable GitHub PagesEnable GitHub Pages

      -

      Pushing Changes

      -

      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.

      -
      -
      -
      1
+
+
      
+
      πŸͺ΄ Quartz 3.2
      Search IconIcon to open search
      
+
      Deploying Quartz to the Web
      Last updated April 5, 2022
      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
      By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the ‘Actions’ tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
      Enable GitHub ActionsEnable GitHub Actions
      Enable GitHub Pages
      Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
      1. (IMPORTANT) Set the source to deploy from master (and not hugo) using / (root)
      2. Set a custom domain here if you have one!
      Enable GitHub PagesEnable GitHub Pages
      Pushing Changes
      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.
      
-
      1
 2
 3
 4
@@ -90,108 +13,36 @@ Last updated April 5, 2022
 7
 8
 9
-
      		
-
      # Navigate to Quartz folder
-cd <path-to-quartz>
-
-# Commit all changes
-git add .
-git commit -m "message describing changes"
-
-# Push to GitHub to update site
-git push origin hugo
-
      
-
      
-
      Note: we specifically push to the hugo branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the master branch for redeployment.
      
-
      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.
      
-
      Make sure that your baseURL has a trailing /!
      
-
      
-Reference config.toml here
      
-
      
-
-
      
-
      1
-
      		
-
      baseURL = "https://<YOUR-DOMAIN>/"
-
      
-
      
-
      If you are using this under a subdomain (e.g. <YOUR-GITHUB-USERNAME>.github.io/quartz), include the trailing /.
      
-
      
-
-
      
-
      1
-
      		
-
      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.
      
-
      Please note that the cname field should not have any path e.g. end with /quartz or have a trailing /.
      
-
      
-Reference deploy.yaml here
      
-
      
-
      
-
      1
+
      # Navigate to Quartz folder
+cd <path-to-quartz>
+
+# Commit all changes
+git add .
+git commit -m "message describing changes"
+
+# Push to GitHub to update site
+git push origin hugo
+
      Note: we specifically push to the hugo branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the master branch for redeployment.
      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.
      Make sure that your baseURL has a trailing /!
      Reference config.toml here
      1
+
      baseURL = "https://<YOUR-DOMAIN>/"
+
      If you are using this under a subdomain (e.g. <YOUR-GITHUB-USERNAME>.github.io/quartz), include the trailing /.
      1
+
      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.
      Please note that the cname field should not have any path e.g. end with /quartz or have a trailing /.
      Reference deploy.yaml here
      
-
      1
 2
 3
 4
 5
 6
 7
-
      		
-
      - name: Deploy  
-  uses: peaceiris/actions-gh-pages@v3  
-  with:  
-	github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!
-	publish_dir: ./public  
-	publish_branch: master
-	cname: <YOUR-DOMAIN>
-
      
-
      
-
      Have a custom domain?
-Learn how to set it up with Quartz .
      
-
      
-
      Now that your Quartz is live, let’s figure out how to make Quartz really yours!
      
-
      🎨
-Customizing Quartz
      
-
      Having problems? Checkout our
-FAQ and Troubleshooting guide.
      
-
      
-
      
-
      
-
      
-
      Backlinks
      
-
-
      
-
      
-
-
      Interactive Graph
      
-
      
-
-
-
-
      
-
      
-
      
-
-
      
-
-
-
      
-
-
\ No newline at end of file
+
      - name: Deploy  
+  uses: peaceiris/actions-gh-pages@v3  
+  with:  
+	github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us!
+	publish_dir: ./public  
+	publish_branch: master
+	cname: <YOUR-DOMAIN>
+

      Have a custom domain? +Learn how to set it up with Quartz .

      Now that your Quartz is live, let’s figure out how to make Quartz really yours!

      🎨 +Customizing Quartz

      Having problems? Checkout our +FAQ and Troubleshooting guide.

      Backlinks

      Interactive Graph

      +
      +
      \ No newline at end of file diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html index 3bd51d5e9..164b2cbd4 100644 --- a/notes/ignore-notes/index.html +++ b/notes/ignore-notes/index.html @@ -1,126 +1,34 @@ - - - - -Ignoring Notes - - - - - - - +Ignoring Notes + - - - - - - -
      -
      - -
      -
      -
      -
      - - -
      -
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search -
      -
      - - - -
      -
      -
      -

      Ignoring Notes

      -

      -Last updated April 5, 2022 -

      -
        -
      -

      Quartz Ignore

      -

      Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.

      -
      -
      -
      1
+
+
      
+
      πŸͺ΄ Quartz 3.2
      Search IconIcon to open search
      
+
      Ignoring Notes
      Last updated April 5, 2022
        Quartz Ignore
        Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
        
-
        1
 2
 3
 4
 5
 6
-
        		
-
        ...
-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 .pngs by doing \\.png$).
-To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.
        
-
        
-
        
-
        1
+
        ...
+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 .pngs by doing \\.png$).
+To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.
        
-
        1
 2
 3
 4
 5
-
        		
-
        ---
-title: Some Private Note
-draft: true
----
-...
-
        
-
        
-
        More details in
-Hugo’s documentation.
        
-
        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.
        
-
        
-
        
-
        
-
        
-
        Backlinks
        
-
-
        
-
        
-
-
        Interactive Graph
        
-
        
-
-
-
-
        
-
        
-
        
-
-
        
-
-
-
        
-
-
\ No newline at end of file
+
        ---
+title: Some Private Note
+draft: true
+---
+...
+

        More details in +Hugo’s documentation.

        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.

        Backlinks

        Interactive Graph

        +
        +
        \ No newline at end of file diff --git a/notes/index.html b/notes/index.html index 96665f333..80ddd9c8a 100644 --- a/notes/index.html +++ b/notes/index.html @@ -1,182 +1,13 @@ - - - - -Notes - - - - - - - +Notes + - - - - - - -
        -
        - -
        -
        -
        -
        - - -
        -
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search -
        -
        - - - -
        -
        -
        -

        All Notes

        -
        • -
          -
          -

          Setup

          -

          Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

          -
          -

          -2 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Quartz Philosophy

          -

          β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important....

          -
          -

          -1 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          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!...

          -
          -

          -1 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Obsidian Vault Integration

          -

          Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

          -
          -

          -2 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Ignoring Notes

          -

          Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered. -1 2 3 4 5 6 ....

          -
          -

          -1 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Editing Content in Quartz

          -

          Editing Quartz runs on top of Hugo so all notes are written in Markdown. -Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....

          -
          -

          -2 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          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!...

          -
          -

          -2 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Custom Domain

          -

          Registrar This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step....

          -
          -

          -1 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Configuration

          -

          Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....

          -
          -

          -2 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          CJK + Latex Support (ζ΅‹θ―•)

          -

          Chinese, Japanese, Korean Support ε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚ + +

          +

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search
          +

          All Notes

          • Setup

            Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

            2 minute read. Last updated April 5, 2022

          • Quartz Philosophy

            β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important....

            1 minute read. Last updated April 5, 2022

          • 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!...

            1 minute read. Last updated April 5, 2022

          • Obsidian Vault Integration

            Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

            2 minute read. Last updated April 5, 2022

          • Ignoring Notes

            Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered. +1 2 3 4 5 6 ....

            1 minute read. Last updated April 5, 2022

          • Editing Content in Quartz

            Editing Quartz runs on top of Hugo so all notes are written in Markdown. +Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....

            2 minute read. Last updated April 5, 2022

          • 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!...

            2 minute read. Last updated April 5, 2022

          • Custom Domain

            Registrar This step is only applicable if you are using a custom domain! If you are using a <YOUR-USERNAME>.github.io domain, you can skip this step....

            1 minute read. Last updated April 5, 2022

          • Configuration

            Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....

            2 minute read. Last updated April 5, 2022

          • CJK + Latex Support (ζ΅‹θ―•)

            Chinese, Japanese, Korean Support ε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚ μš°λ¦¬κ°€ 그것을 μ•ŒκΈ°λ„ 전에 μš°λ¦¬λŠ” 땅을 λ– λ‚¬μŠ΅λ‹ˆλ‹€. η§γŸγ‘γŒγγ‚Œγ‚’ηŸ₯γ‚‹γ»γΌε‰γ«γ€η§γŸγ‘γ―εœ°ι’γ‚’ι›’γ‚Œγ¦γ„γΎγ—γŸγ€‚ -Latex Block math works with two dollar signs $$....

            -
            -

            -1 minute read. Last updated Unknown -

            -
            -
          - -
          -
          - -
          -
          - - - - \ No newline at end of file +Latex Block math works with two dollar signs $$....

          1 minute read. Last updated Unknown

        + \ No newline at end of file diff --git a/notes/index.xml b/notes/index.xml index 4edbf7be6..a4787840e 100644 --- a/notes/index.xml +++ b/notes/index.xml @@ -4,5 +4,5 @@ Latex Block math works with two dollar signs $$.Configurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you&rsquo;d like to get.Custom Domainhttps://quartz.jzhao.xyz/notes/custom-Domain/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/custom-Domain/Registrar This step is only applicable if you are using a custom domain! If you are using a &lt;YOUR-USERNAME&gt;.github.io domain, you can skip this step.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/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!Editing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown. Obsidian I recommend using Obsidian as a way to edit and grow your digital garden.Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you&rsquo;d like to exclude from being rendered. 1 2 3 4 5 6 .Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.Preview Changeshttps://quartz.jzhao.xyz/notes/preview-changes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/preview-changes/If you&rsquo;d like to preview what your Quartz site looks like before deploying it to the internet, here&rsquo;s exactly how to do that!Quartz Philosophyhttps://quartz.jzhao.xyz/notes/philosophy/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/philosophy/β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.Setuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!Showcasehttps://quartz.jzhao.xyz/notes/showcase/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/showcase/Want to see what Quartz can do? Here are some cool community gardens :) -Quartz Documentation (this site!) Strengthening Online Social Bonds: Research Garden Jacky Zhao&rsquo;s Garden Anson Yu&rsquo;s Garden Shihyu&rsquo;s PKM Chloe&rsquo;s Garden SlRvb&rsquo;s Site Course notes for Information Technology Advanced Theory Brandon Boswell&rsquo;s Garden Siyang&rsquo;s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. +Quartz Documentation (this site!) Jacky Zhao&rsquo;s Garden AWAGMI Intern Notes Shihyu&rsquo;s PKM Chloe&rsquo;s Garden SlRvb&rsquo;s Site Course notes for Information Technology Advanced Theory Brandon Boswell&rsquo;s Garden Siyang&rsquo;s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!Troubleshooting and FAQhttps://quartz.jzhao.xyz/notes/troubleshooting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/troubleshooting/Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. While you&rsquo;re here, join our Discord :) \ No newline at end of file diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html index 53da44356..e31ae84d8 100644 --- a/notes/obsidian/index.html +++ b/notes/obsidian/index.html @@ -1,104 +1,11 @@ - - - - -Obsidian Vault Integration - - - - - - - +Obsidian Vault Integration + - - - - - - -
        -
        - -
        -
        -
        -
        - - -
        -
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search -
        -
        - - - -
        -
        -
        -

        Obsidian Vault Integration

        -

        -Last updated April 5, 2022 -

        - -

        Setup

        -

        Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.

        -

        New Vault

        -

        If you don’t have an existing Vault, + +

        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        Obsidian Vault Integration

        Last updated April 5, 2022

        Setup

        Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.

        New Vault

        If you don’t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the -setup step.

        -

        Linking an existing Vault

        -

        The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the /content folder.

        -

        Settings

        -

        Great, now that you have your Obsidian linked to your Quartz, let’s fix some settings so that they play well.

        -
          -
        1. Under Options > Files and Links, set the New link format to always e Absolute Path in Vault.
          2. -
        2. Go to Settings > Files & Links > Turn “on” automatically update internal links.
          3. -
        -

        -Obsidian SettingsObsidian Settings

        -

        Templates

        -

        Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.

        -

        If you decide to overwrite the /content folder completely, don’t remove the /content/templates folder!

        -

        Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for ‘Insert Template’ (I recomment [cmd]+T). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!

        -
        -
        -
        -
        -

        Backlinks

        - -
        -
        - -

        Interactive Graph

        -
        - - - -
        -
        -
        - -
        - - -
        - - \ No newline at end of file +setup step.

        Linking an existing Vault

        The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the /content folder.

        Settings

        Great, now that you have your Obsidian linked to your Quartz, let’s fix some settings so that they play well.

        1. Under Options > Files and Links, set the New link format to always e Absolute Path in Vault.
        2. Go to Settings > Files & Links > Turn “on” automatically update internal links.

        Obsidian SettingsObsidian Settings

        Templates

        Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.

        If you decide to overwrite the /content folder completely, don’t remove the /content/templates folder!

        Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for ‘Insert Template’ (I recomment [cmd]+T). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!

        Backlinks

        Interactive Graph

        +
        +
        \ No newline at end of file diff --git a/notes/page/1/index.html b/notes/page/1/index.html index 6829fa17f..f1ec6ce7d 100644 --- a/notes/page/1/index.html +++ b/notes/page/1/index.html @@ -1 +1 @@ -https://quartz.jzhao.xyz/notes/ \ No newline at end of file +https://quartz.jzhao.xyz/notes/ \ No newline at end of file diff --git a/notes/page/2/index.html b/notes/page/2/index.html index a7066edc6..a57da3945 100644 --- a/notes/page/2/index.html +++ b/notes/page/2/index.html @@ -1,99 +1,10 @@ - - - - -Notes - - - - - - - +Notes + - - - - - - -
        -
        - -
        -
        -
        -
        - - -
        -
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search -
        -
        - - - -
        -
        -
        -

        All Notes

        -
        • -
          -
          -

          Troubleshooting and FAQ

          -

          Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. -While you’re here, join our Discord :)...

          -
          -

          -3 minute read. Last updated April 5, 2022 -

          -
          -
        • -
          -
          -

          Showcase

          -

          Want to see what Quartz can do? Here are some cool community gardens :) -Quartz Documentation (this site!) Strengthening Online Social Bonds: Research Garden Jacky Zhao’s Garden Anson Yu’s Garden Shihyu’s PKM Chloe’s Garden SlRvb’s Site Course notes for Information Technology Advanced Theory Brandon Boswell’s Garden Siyang’s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!...

          -
          -

          -1 minute read. Last updated April 5, 2022 -

          -
          -
        - -
        -
        - -
        -
        - - - - \ No newline at end of file + +
        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        All Notes

        • Troubleshooting and FAQ

          Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. +While you’re here, join our Discord :)...

          3 minute read. Last updated April 5, 2022

        • Showcase

          Want to see what Quartz can do? Here are some cool community gardens :) +Quartz Documentation (this site!) Jacky Zhao’s Garden AWAGMI Intern Notes Shihyu’s PKM Chloe’s Garden SlRvb’s Site Course notes for Information Technology Advanced Theory Brandon Boswell’s Garden Siyang’s Courtyard If you want to see your own on here, submit a Pull Request adding yourself to this file!...

          1 minute read. Last updated April 5, 2022

        + \ No newline at end of file diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html index 8e18f329d..e91211842 100644 --- a/notes/philosophy/index.html +++ b/notes/philosophy/index.html @@ -1,98 +1,14 @@ - - - - -Quartz Philosophy - - - - - - - +Quartz Philosophy + - - - - - - -
        -
        - -
        -
        -
        -
        - - -
        -
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search -
        -
        - - - -
        -
        -
        -

        Quartz Philosophy

        -

        -Last updated April 5, 2022 -

        -
          -
        -
        -

        β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” β€” Richard Hamming

        -
        -

        Why Quartz?

        -

        Hosting a public digital garden isn’t easy. There are an overwhelming number of tutorials, resources, and guides for tools like + +

        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        Quartz Philosophy

        Last updated April 5, 2022

          β€œ[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” β€” Richard Hamming

          Why Quartz?

          Hosting a public digital garden isn’t easy. There are an overwhelming number of tutorials, resources, and guides for tools like Notion, Roam, and -Obsidian, yet none of them have super easy to use free tools to publish that garden to the world.

          -

          I’ve personally found that

          -
            -
          1. It’s nice to access notes from anywhere
            2. -
          2. Having a public digital garden invites open conversations
            3. -
          3. It makes keeping personal notes and knowledge playful and fun
            4. -
          -

          I was really inspired by +Obsidian, yet none of them have super easy to use free tools to publish that garden to the world.

          I’ve personally found that

          1. It’s nice to access notes from anywhere
          2. Having a public digital garden invites open conversations
          3. It makes keeping personal notes and knowledge playful and fun

          I was really inspired by Bianca and -Joel’s digital gardens and wanted to try making my own.

          -

          The goal of Quartz is to make hosting your own public digital garden free and simple. You don’t even need your own website. Quartz does all of that for you and gives your own little corner of the internet.

          -
          -
          -
          -
          -

          Backlinks

          - -
          -
          - -

          Interactive Graph

          -
          - - - -
          -
          -
          - -
          - - -
          - - \ No newline at end of file +Joel’s digital gardens and wanted to try making my own.

          The goal of Quartz is to make hosting your own public digital garden free and simple. You don’t even need your own website. Quartz does all of that for you and gives your own little corner of the internet.

          Backlinks

          Interactive Graph

          +
          +
          \ No newline at end of file diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html index 769e66ba6..4e5832921 100644 --- a/notes/preview-changes/index.html +++ b/notes/preview-changes/index.html @@ -1,58 +1,11 @@ - - - - -Preview Changes - - - - - - - +Preview Changes + - - - - - - -
          -
          - -
          -
          -
          -
          - - -
          -
          -

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search -
          -
          - - - -
          -
          -
          -

          Preview Changes

          -

          -Last updated April 5, 2022 -

          -
            -
          -

          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

          -

          This step will generate the list of backlinks for Hugo to parse. Ensure you have -Go (>= 1.16) installed.

          -
          -
          -
          1
+
+
          
+
          πŸͺ΄ Quartz 3.2
          Search IconIcon to open search
          
+
          Preview Changes
          Last updated April 5, 2022
            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
            This step will generate the list of backlinks for Hugo to parse. Ensure you have
+Go (>= 1.16) installed.
            
-
            1
 2
 3
 4
@@ -60,74 +13,29 @@ Last updated April 5, 2022
 6
 7
 8
-
            		
-
            # Install and link `hugo-obsidian` locally
-$ go install github.com/jackyzha0/hugo-obsidian@latest
-
-# 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=assets/indices -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!
            
-
            Installing Hugo
            
-
            Hugo is the static site generator that powers Quartz.
-Install Hugo with “extended” Sass/SCSS version first. Then,
            
-
            
-
            
-
            1
+
            # Install and link `hugo-obsidian` locally
+$ go install github.com/jackyzha0/hugo-obsidian@latest
+
+# 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=assets/indices -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!
            Installing Hugo
            Hugo is the static site generator that powers Quartz.
+Install Hugo with “extended” Sass/SCSS version first. Then,
            
-
            1
 2
 3
 4
 5
 6
 7
-
            		
-
            # 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/
-
            
-
            
-
            
-
            
-
            
-
            
-
            
-
            Backlinks
            
-
-
            
-
            
-
-
            Interactive Graph
            
-
            
-
-
-
-
            
-
            
-
            
-
-
            
-
-
-
            
-
-
\ No newline at end of file
+
            # 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/
+

            Backlinks

            Interactive Graph

            +
            +
            \ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index f39993c4c..4c5d097eb 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,171 +1,38 @@ - - - - -Setup - - - - - - - +Setup + - - - - - - -
            -
            - -
            -
            -
            -
            - - -
            -
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search -
            -
            - - - -
            -
            -
            -

            Setup

            -

            -Last updated April 5, 2022 -

            - - -

            Making your own Quartz

            -

            Setting up Quartz requires a basic understanding of git. If you are unfamiliar, -this resource is a great place to start!

            -

            Forking

            -
            -

            A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

            -
            -

            Navigate to the GitHub repository for the Quartz project:

            -

            πŸ“ -Quartz Repository

            -

            Then, Fork the repository into your own GitHub account. If you don’t have an account, you can make on for free + +

            +

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search
            +

            Setup

            Last updated April 5, 2022

            Making your own Quartz

            Setting up Quartz requires a basic understanding of git. If you are unfamiliar, +this resource is a great place to start!

            Forking

            A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

            Navigate to the GitHub repository for the Quartz project:

            πŸ“ +Quartz Repository

            Then, Fork the repository into your own GitHub account. If you don’t have an account, you can make on for free here. More details about forking a repo can be found on -GitHub’s documentation.

            -

            Cloning

            -

            After you’ve made a fork of the repository, you need to download the files locally onto your machine. Ensure you have git, then type the following command replacing YOUR-USERNAME with your GitHub username.

            -
            - -
            -
            1
-
            		 -
            $ git clone https://github.com/YOUR-USERNAME/quartz
-
            -
            -

            Editing

            -

            Great! Now you have everything you need to start editing and growing your digital garden. If you’re ready to start writing content already, check out the recommended flow for editing notes in Quartz.

            -

            ✏️ -Editing Notes in Quartz

            -

            Having problems? Checkout our -FAQ and Troubleshooting guide.

            -

            Updating

            -

            Haven’t updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press q to acknowledge this. Then, it will show you each change in turn and press y to accept the patch or n to reject it. Usually you should press y for most of these unless it conflicts with existing changes you’ve made!

            -
            -
            -
            1
+GitHub’s documentation.
            Cloning
            After you’ve made a fork of the repository, you need to download the files locally onto your machine. Ensure you have git, then type the following command replacing YOUR-USERNAME with your GitHub username.
            1
+
            $ git clone https://github.com/YOUR-USERNAME/quartz
+
            Editing
            Great! Now you have everything you need to start editing and growing your digital garden. If you’re ready to start writing content already, check out the recommended flow for editing notes in Quartz.
            ✏️
+Editing Notes in Quartz
            Having problems? Checkout our
+FAQ and Troubleshooting guide.
            Updating
            Haven’t updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press q to acknowledge this. Then, it will show you each change in turn and press y to accept the patch or n to reject it. Usually you should press y for most of these unless it conflicts with existing changes you’ve made!
            
-
            1
 2
 3
 4
-
            		
-
            make update
-
-# or, if you don't want the interactive parts and just want the update
-make update-force
-
            
-
            
-
            Or, manually checkout the changes yourself.
            
-
            
-
            ⚠️ WARNING ⚠️
            
-
            If you customized the files in data/, or anything inside layouts/, your customization may be overwritten!
-Make sure you have a copy of these changes if you don’t want to lose them.
            
-
            
-
            
-
            
-
            1
+
            make update
+
+# or, if you don't want the interactive parts and just want the update
+make update-force
+
            Or, manually checkout the changes yourself.
            ⚠️ WARNING ⚠️
            If you customized the files in data/, or anything inside layouts/, your customization may be overwritten!
+Make sure you have a copy of these changes if you don’t want to lose them.
            
-
            1
 2
 3
 4
 5
 6
-
            		
-
            # add Quartz as a remote host
-git remote add upstream git@github.com:jackyzha0/quartz.git
-
-# index and fetch changes
-git fetch upstream
-git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data 
-
            
-
            
-
            
-
-
            
-
            
-
            
-
            Backlinks
            
-
-
            
-
            
-
-
            Interactive Graph
            
-
            
-
-
-
-
            
-
            
-
            
-
-
            
-
-
-
-
-
\ No newline at end of file
+
            # add Quartz as a remote host
+git remote add upstream git@github.com:jackyzha0/quartz.git
+
+# index and fetch changes
+git fetch upstream
+git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data 
+

            Backlinks

            Interactive Graph

            +
            +
            \ No newline at end of file diff --git a/notes/showcase/index.html b/notes/showcase/index.html index 65a732a96..c0f491cc4 100644 --- a/notes/showcase/index.html +++ b/notes/showcase/index.html @@ -1,106 +1,11 @@ - - - - -Showcase - - - - - - - +Showcase + - - - - - - -
            -
            - -
            -
            -
            -
            - - -
            -
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search -
            -
            - - - -
            -
            -
            -

            Showcase

            -

            -Last updated April 5, 2022 -

            -
              -
            -

            Want to see what Quartz can do? Here are some cool community gardens :)

            - -

            If you want to see your own on here, submit a -Pull Request adding yourself to this file!

            -
            -
            -
            -
            -

            Backlinks

            - -
            -
            - -

            Interactive Graph

            -
            - - - -
            -
            -
            - -
            - - -
            - - \ No newline at end of file + +
            +

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search
            +

            Backlinks

            Interactive Graph

            +
            +
            \ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 49f5acfc6..aa7d62813 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,214 +1,48 @@ - - - - -Troubleshooting and FAQ - - - - - - - +Troubleshooting and FAQ + - - - - - - -
            -
            - -
            -
            -
            -
            - - -
            -
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search -
            -
            - - - -
            -
            -
            -

            Troubleshooting and FAQ

            -

            -Last updated April 5, 2022 -

            -
              -
            - -

            Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.

            -

            While you’re here, join our -Discord :)

            -

            Does Quartz have Latex support?

            -

            Yes! See -CJK + Latex Support (ζ΅‹θ―•) for a brief demo.

            -

            Can I use <Obsidian Plugin> in Quartz?

            -

            Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.

            -

            The easiest way would be to add your own HTML partial that supports the functionality you are looking for.

            -

            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 guide

            -

            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.

            -
            -
            -
            1
+
+
            
+
            πŸͺ΄ Quartz 3.2
            Search IconIcon to open search
            
+
            Troubleshooting and FAQ
            Last updated April 5, 2022
              Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
              While you’re here, join our
+Discord :)
              Does Quartz have Latex support?
              Yes! See
+CJK + Latex Support (ζ΅‹θ―•) for a brief demo.
              Can I use <Obsidian Plugin> in Quartz?
              Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.
              The easiest way would be to add your own HTML partial that supports the functionality you are looking for.
              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 guide
              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.
              
-
              1
 2
 3
 4
 5
-
              		
-
              # in the root of your Quartz (same folder as config.toml)
-git config core.ignorecase true
-
-# or globally (not recommended)
-git config --global core.ignorecase true
-
              
-
              
-
              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.
              
-
              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.
              
-
              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.
              
-
              
-
              
-
              1
+
              # in the root of your Quartz (same folder as config.toml)
+git config core.ignorecase true
+
+# or globally (not recommended)
+git config --global core.ignorecase true
+
              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.
              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.
              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.
              
-
              1
 2
 3
 4
 5
 6
-
              		
-
              # Add the following 2 lines to your ~/.bash_profile
-export GOPATH=/Users/$USER/go
-export PATH=$GOPATH/bin:$PATH
-
-# In your current terminal, to reload the session
-source ~/.bash_profile
-
              
-
              
-
              How come my notes aren’t being rendered?
              
-
              You probably forgot to include front matter in your Markdown files. You can either setup
+
              # Add the following 2 lines to your ~/.bash_profile
+export GOPATH=/Users/$USER/go
+export PATH=$GOPATH/bin:$PATH
+
+# In your current terminal, to reload the session
+source ~/.bash_profile
+

              How come my notes aren’t being rendered?

              You probably forgot to include front matter in your Markdown files. You can either setup Obsidian to do this for you or you need to manually define it. More details in -the ‘how to edit’ guide.

              -

              My custom domain isn’t working!

              -

              Walk through the steps in -the hosting guide again. Make sure you wait 30 min to 1 hour for changes to take effect.

              -

              How do I setup Google Analytics?

              -

              You can edit it in config.toml and either use a V3 (UA-) or V4 (G-) tag.

              -

              How do I change the content on the home page?

              -

              To edit the main home page, open /content/_index.md.

              -

              How do I change the colours?

              -

              You can change the theme by editing assets/custom.scss. More details on customization and themeing can be found in the -customization guide.

              -

              How do I add images?

              -

              You can put images anywhere in the /content folder.

              -
              -
              -
              1
+the ‘how to edit’ guide.
              My custom domain isn’t working!
              Walk through the steps in
+the hosting guide again. Make sure you wait 30 min to 1 hour for changes to take effect.
              How do I setup Google Analytics?
              You can edit it in config.toml and either use a V3 (UA-) or V4 (G-) tag.
              How do I change the content on the home page?
              To edit the main home page, open /content/_index.md.
              How do I change the colours?
              You can change the theme by editing assets/custom.scss. More details on customization and themeing can be found in the
+customization guide.
              How do I add images?
              You can put images anywhere in the /content folder.
              
-
              1
 2
-
              		
-
              Example image (source is in content/notes/images/example.png)
-![Example Image](/content/notes/images/example.png)
-
              
-
              
-
              
-
              By default, the linkIndex.json (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on
-local editing
              
-
              Can I use React/Vue/some other framework?
              
-
              Not out of the box. You could probably make it work by editing /layouts/_default/single.html but that’s not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
              
-
              Still Stuck?
              
-
              Quartz isn’t perfect! If you’re still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on
-Twitter and I’ll try to get back to you as soon as I can.
              
-
              πŸ›
-Submit an Issue
              
-
-
              
-
              
-
              
-
              Backlinks
              
-
-
              
-
              
-
-
              Interactive Graph
              
-
              
-
-
-
-
              
-
              
-
              
-
-
              
-
-
-
-
-
\ No newline at end of file
+
              Example image (source is in content/notes/images/example.png)
+![Example Image](/content/notes/images/example.png)
+

              By default, the linkIndex.json (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on +local editing

              Can I use React/Vue/some other framework?

              Not out of the box. You could probably make it work by editing /layouts/_default/single.html but that’s not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.

              Still Stuck?

              Quartz isn’t perfect! If you’re still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on +Twitter and I’ll try to get back to you as soon as I can.

              πŸ› +Submit an Issue

              Backlinks

              Interactive Graph

              +
              +
              \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 182a11a03..7e406cd9d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95/https://quartz.jzhao.xyz/notes/config/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/hosting/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/editing/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/obsidian/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/preview-changes/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/philosophy/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/setup/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/tags/setup/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/showcase/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/tags/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-04-05T20:44:39-07:00https://quartz.jzhao.xyz/2022-04-05T20:44:39-07:00 \ No newline at end of file +https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95/https://quartz.jzhao.xyz/notes/config/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/hosting/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/editing/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/obsidian/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/preview-changes/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/philosophy/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/setup/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/tags/setup/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/showcase/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/tags/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-04-05T21:40:59-07:00https://quartz.jzhao.xyz/2022-04-05T21:40:59-07:00 \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index 019756996..cdf4fb2aa 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,83 +1,8 @@ - - - - -Tags - - - - - - - +Tags + - - - - - - -
              -
              - -
              -
              -
              -
              - - -
              -
              -

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search -
              -
              - - - -
              -
              -
              -

              All Tags

              -
              -
              -

              setup

              -

              5 notes with this tag (showing first 2 results)

              -
              -
              • -
                -
                -

                Setup

                -

                Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              • -
                -
                -

                Obsidian Vault Integration

                -

                Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              -
              -
              -
              - -
              -
              - - - - \ No newline at end of file + +
              +

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search
              +

              All Tags

              setup

              5 notes with this tag (showing first 2 results)

              • Setup

                Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

                2 minute read. Last updated April 5, 2022

              • Obsidian Vault Integration

                Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

                2 minute read. Last updated April 5, 2022

              + \ No newline at end of file diff --git a/tags/setup/index.html b/tags/setup/index.html index 8ed55d7ad..576c0bde2 100644 --- a/tags/setup/index.html +++ b/tags/setup/index.html @@ -1,108 +1,9 @@ - - - - -setup - - - - - - - +setup + - - - - - - -
              -
              - -
              -
              -
              -
              - - -
              -
              -

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search -
              -
              - - - -
              -
              -
              -

              Tag: Setup

              -
              • -
                -
                -

                Configuration

                -

                Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              • -
                -
                -

                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!...

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              • -
                -
                -

                Editing Content in Quartz

                -

                Editing Quartz runs on top of Hugo so all notes are written in Markdown. -Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              • -
                -
                -

                Obsidian Vault Integration

                -

                Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              • -
                -
                -

                Setup

                -

                Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

                -
                -

                -2 minute read. Last updated April 5, 2022 -

                -
                -
              -
              -
              - -
              -
              - - - - \ No newline at end of file + +
              +

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search
              +

              Tag: Setup

              • Configuration

                Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get....

                2 minute read. Last updated April 5, 2022

              • 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!...

                2 minute read. Last updated April 5, 2022

              • Editing Content in Quartz

                Editing Quartz runs on top of Hugo so all notes are written in Markdown. +Obsidian I recommend using Obsidian as a way to edit and grow your digital garden....

                2 minute read. Last updated April 5, 2022

              • Obsidian Vault Integration

                Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have....

                2 minute read. Last updated April 5, 2022

              • Setup

                Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!...

                2 minute read. Last updated April 5, 2022

              + \ No newline at end of file diff --git a/tags/setup/page/1/index.html b/tags/setup/page/1/index.html index 274b04fa6..4323b1964 100644 --- a/tags/setup/page/1/index.html +++ b/tags/setup/page/1/index.html @@ -1 +1 @@ -https://quartz.jzhao.xyz/tags/setup/ \ No newline at end of file +https://quartz.jzhao.xyz/tags/setup/ \ No newline at end of file