diff --git a/404.html b/404.html index 933d53421..6c10ba335 100644 --- a/404.html +++ b/404.html @@ -1,36 +1,6 @@ 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 diff --git a/categories/index.html b/categories/index.html index ea0d85d5c..ec78e00d5 100644 --- a/categories/index.html +++ b/categories/index.html @@ -1,38 +1,8 @@ Categories - +
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

πŸͺ΄ Quartz 3.2

Search IconIcon to open search

All Categories

setup

5 notes with this tag (showing first 2 results)

  • 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 17, 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/index.html b/index.html index 0c83cb3b8..6c0fccfeb 100644 --- a/index.html +++ b/index.html @@ -1,39 +1,9 @@ πŸͺ΄ Quartz 3.2 - +
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

πŸͺ΄ 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 @@ -41,5 +11,6 @@ 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

+Discord Community

Backlinks

  • No backlinks found

Interactive Graph

+
\ No newline at end of file diff --git a/indices/contentIndex.3dfaa0f55407f7cd60a2b70e2986c06d.min.json b/indices/contentIndex.3dfaa0f55407f7cd60a2b70e2986c06d.min.json new file mode 100644 index 000000000..2f339bfd2 --- /dev/null +++ b/indices/contentIndex.3dfaa0f55407f7cd60a2b70e2986c06d.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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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-05-03T14:45:43.587021467Z","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 use 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 recommend `[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-05-03T14:45:43.591021527Z","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-05-03T14:45:43.591021527Z","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-05-03T14:45:43.591021527Z","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-05-03T14:45:43.591021527Z","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-05-03T14:45:43.591021527Z","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-05-03T14:45:43.591021527Z","tags":null}} \ No newline at end of file diff --git a/indices/contentIndex.fd2a7004496d9b91eda3be6d4ed8b94f.min.json b/indices/contentIndex.fd2a7004496d9b91eda3be6d4ed8b94f.min.json deleted file mode 100644 index bf1ba79b7..000000000 --- a/indices/contentIndex.fd2a7004496d9b91eda3be6d4ed8b94f.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-05-03T13:49:48.709575323Z","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-05-03T13:49:48.709575323Z","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-05-03T13:49:48.709575323Z","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-05-03T13:49:48.709575323Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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 use 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 recommend `[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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","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-05-03T13:49:48.71357537Z","tags":null}} \ No newline at end of file diff --git a/js/search.74d9a1189f86e08233be4cdcf037ebc6.min.js b/js/search.74d9a1189f86e08233be4cdcf037ebc6.min.js new file mode 100644 index 000000000..50b687ee3 --- /dev/null +++ b/js/search.74d9a1189f86e08233be4cdcf037ebc6.min.js @@ -0,0 +1,7 @@ +const removeMarkdown=(n,t={listUnicodeChar:!1,stripListLeaders:!0,gfm:!0,useImgAltText:!1,preserveLinks:!1})=>{let e=n||'';e=e.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm,'');try{t.stripListLeaders&&(t.listUnicodeChar?e=e.replace(/^([\s\t]*)([*\-+]|\d+\.)\s+/gm,t.listUnicodeChar+" $1"):e=e.replace(/^([\s\t]*)([*\-+]|\d+\.)\s+/gm,"$1")),t.gfm&&(e=e.replace(/\n={2,}/g,"\n").replace(/~{3}.*\n/g,'').replace(/~~/g,'').replace(/`{3}.*\n/g,'')),t.preserveLinks&&(e=e.replace(/\[(.*?)\][[(](.*?)[\])]/g,"$1 ($2)")),e=e.replace(/<[^>]*>/g,'').replace(/^[=-]{2,}\s*$/g,'').replace(/\[\^.+?\](: .*?$)?/g,'').replace(/(#{1,6})\s+(.+)\1?/g,"$2").replace(/\s{0,2}\[.*?\]: .*?$/g,'').replace(/!\[(.*?)\][[(].*?[\])]/g,t.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(/([*_]{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(e){return console.error(e),n}return e};(async function(){const r=e=>e.toLowerCase().split(/([^a-z]|[^\x00-\x7F])+/),d=new FlexSearch.Document({cache:!0,charset:"latin:extra",optimize:!0,index:[{field:"content",tokenize:"reverse",encode:r},{field:"title",tokenize:"forward",encode:r}]}),{content:s}=await fetchData;for(const[t,e]of Object.entries(s))d.add({id:t,title:e.title,content:removeMarkdown(e.content)});const l=(c,l)=>{const e=20,d=l.split(/\s+/).filter(e=>e!==''),t=c.split(/\s+/).filter(e=>e!==''),i=e=>d.some(t=>e.toLowerCase().startsWith(t.toLowerCase())),s=t.map(i);let o=0,a=0;for(let t=0;te+t,0);n>=o&&(o=n,a=t)}const n=Math.max(a-e,0),r=Math.min(n+2*e,t.length),u=t.slice(n,r).map(e=>i(e)?`${e}`:e).join(" ").replaceAll(' '," ");return`${n===0?'':"..."}${u}${r===t.length?'':"..."}`},m=({url:t,title:n,content:s,term:e})=>{const o=removeMarkdown(s),i=l(n,e),a=l(o,e);return``},c=(e,t)=>{window.navigate(new URL(`${BASE_URL}${e}#:~:text=${encodeURIComponent(t)}/`),".singlePage"),o()},h=e=>({id:e,url:e,title:s[e].title,content:s[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];c(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{i.innerHTML=n.map(e=>m({...e,term:t})).join("\n");const e=[...document.getElementsByClassName("result-card")];e.forEach(e=>{e.onclick=()=>c(e.id,t)})}});const e=document.getElementById("search-container");function a(){e.style.display==="none"||e.style.display===''?(n.value='',i.innerHTML='',e.style.display="block",n.focus()):e.style.display="none"}function o(){e.style.display="none"}document.addEventListener("keydown",e=>{e.key==="k"&&(e.ctrlKey||e.metaKey)&&(e.preventDefault(),a()),e.key==="Escape"&&(e.preventDefault(),o())});const u=document.getElementById("search-icon");u.addEventListener("click",e=>{a()}),u.addEventListener("keydown",e=>{a()}),e.addEventListener("click",e=>{o()}),document.getElementById("search-space").addEventListener("click",e=>{e.stopPropagation()})})() \ No newline at end of file diff --git a/js/search.cd35ece60ea7aafd35625f0def8097a5.min.js b/js/search.cd35ece60ea7aafd35625f0def8097a5.min.js deleted file mode 100644 index db0be0db8..000000000 --- a/js/search.cd35ece60ea7aafd35625f0def8097a5.min.js +++ /dev/null @@ -1,7 +0,0 @@ -const removeMarkdown=(n,t={listUnicodeChar:!1,stripListLeaders:!0,gfm:!0,useImgAltText:!1,preserveLinks:!1})=>{let e=n||'';e=e.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm,'');try{t.stripListLeaders&&(t.listUnicodeChar?e=e.replace(/^([\s\t]*)([*\-+]|\d+\.)\s+/gm,t.listUnicodeChar+" $1"):e=e.replace(/^([\s\t]*)([*\-+]|\d+\.)\s+/gm,"$1")),t.gfm&&(e=e.replace(/\n={2,}/g,"\n").replace(/~{3}.*\n/g,'').replace(/~~/g,'').replace(/`{3}.*\n/g,'')),t.preserveLinks&&(e=e.replace(/\[(.*?)\][[(](.*?)[\])]/g,"$1 ($2)")),e=e.replace(/<[^>]*>/g,'').replace(/^[=-]{2,}\s*$/g,'').replace(/\[\^.+?\](: .*?$)?/g,'').replace(/\s{0,2}\[.*?\]: .*?$/g,'').replace(/!\[(.*?)\][[(].*?[\])]/g,t.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(/([*_]{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(e){return console.error(e),n}return e};(async function(){const r=e=>e.toLowerCase().split(/([^a-z]|[^\x00-\x7F])+/),d=new FlexSearch.Document({cache:!0,charset:"latin:extra",optimize:!0,index:[{field:"content",tokenize:"reverse",encode:r},{field:"title",tokenize:"forward",encode:r}]}),{content:s}=await fetchData;for(const[t,e]of Object.entries(s))d.add({id:t,title:e.title,content:removeMarkdown(e.content)});const l=(c,l)=>{const e=20,d=l.split(/\s+/).filter(e=>e!==''),t=c.split(/\s+/).filter(e=>e!==''),i=e=>d.some(t=>e.toLowerCase().startsWith(t.toLowerCase())),s=t.map(i);let o=0,a=0;for(let t=0;te+t,0);n>=o&&(o=n,a=t)}const n=Math.max(a-e,0),r=Math.min(n+2*e,t.length),u=t.slice(n,r).map(e=>i(e)?`${e}`:e).join(" ").replaceAll(' '," ");return`${n===0?'':"..."}${u}${r===t.length?'':"..."}`},m=({url:t,title:n,content:s,term:e})=>{const o=removeMarkdown(s),i=l(n,e),a=l(o,e);return``},c=(e,t)=>{window.navigate(new URL(`${BASE_URL.slice(0,-1)}${e}#:~:text=${encodeURIComponent(t)}/`),".singlePage"),o()},h=e=>({id:e,url:e,title:s[e].title,content:s[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];c(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{i.innerHTML=n.map(e=>m({...e,term:t})).join("\n");const e=[...document.getElementsByClassName("result-card")];e.forEach(e=>{e.onclick=()=>c(e.id,t)})}});const e=document.getElementById("search-container");function a(){e.style.display==="none"||e.style.display===''?(n.value='',i.innerHTML='',e.style.display="block",n.focus()):e.style.display="none"}function o(){e.style.display="none"}document.addEventListener("keydown",e=>{e.key==="k"&&(e.ctrlKey||e.metaKey)&&(e.preventDefault(),a()),e.key==="Escape"&&(e.preventDefault(),o())});const u=document.getElementById("search-icon");u.addEventListener("click",e=>{a()}),u.addEventListener("keydown",e=>{a()}),e.addEventListener("click",e=>{o()}),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 263c3b98d..54993c2db 100644 --- a/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html +++ b/notes/CJK-+-Latex-Support-ζ΅‹θ―•/index.html @@ -4,39 +4,9 @@ Latex Block math works with two dollar signs $$.">CJK + Latex Support (ζ΅‹θ―•) - +
-

πŸͺ΄ Quartz 3.2

Search IconIcon to open search
+

πŸͺ΄ 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:

    $$ @@ -47,5 +17,6 @@ $$

    And matrices

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

    # RTL

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

    Backlinks

    Interactive Graph

    +config page.

    Backlinks

    Interactive Graph

    +
    \ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index 1e29cb7ac..a6487e149 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,39 +1,9 @@ Configuration - +
    -

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search
    +

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search

    Configuration

    Last updated April 2, 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
@@ -83,5 +53,6 @@
     languagedirection = 'rtl'
     title = 'Ω…Ψ―ΩˆΩ†Ψͺي'
     weight = 1
-

    Backlinks

    Interactive Graph

    +

    Backlinks

    Interactive Graph

    +
    \ No newline at end of file diff --git a/notes/custom-Domain/index.html b/notes/custom-Domain/index.html index 52296841b..2c819633e 100644 --- a/notes/custom-Domain/index.html +++ b/notes/custom-Domain/index.html @@ -1,39 +1,10 @@ Custom Domain - +
    -

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search
    +

    πŸͺ΄ Quartz 3.2

    Search IconIcon to open search

    Custom Domain

    Last updated January 27, 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

      +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 993f1ef8a..1dae1d8bb 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -2,39 +2,9 @@ Obsidian I recommend using Obsidian as a way to edit and grow your digital garden.">Editing Content in Quartz - +
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search
      +

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search

      # 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

      +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 2f1cf09a7..0468bbb3f 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,39 +1,9 @@ Deploying Quartz to the Web - +
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search
      +

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search

      Deploying Quartz to the Web

      Last updated February 17, 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
@@ -73,5 +43,6 @@

      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

      +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 68dff8827..bb1694b74 100644 --- a/notes/ignore-notes/index.html +++ b/notes/ignore-notes/index.html @@ -2,39 +2,9 @@ 1 2 3 4 5 6 .">Ignoring Notes - +
      -

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search
      +

      πŸͺ΄ Quartz 3.2

      Search IconIcon to open search

      Ignoring Notes

      Last updated November 20, 2021

        # Quartz Ignore

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

        1
 2
 3
@@ -59,5 +29,6 @@ To ignore a specific file, you can also add the tag draft: true to
 ---
 ...

        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

        +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 7848d9f52..35e93cbd9 100644 --- a/notes/index.html +++ b/notes/index.html @@ -1,39 +1,9 @@ Notes - +
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search

        All Notes

        • 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 17, 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

        • 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 3, 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 2, 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 March 4, 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 February 17, 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 January 27, 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 November 20, 2021

        • 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 November 20, 2021

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

          Chinese, Japanese, Korean Support ε‡ δΉŽεœ¨ζˆ‘δ»¬ζ„θ―†εˆ°δΉ‹ε‰οΌŒζˆ‘δ»¬ε·²η»η¦»εΌ€δΊ†εœ°ι’γ€‚ diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html index bdc9d0879..e93255d5e 100644 --- a/notes/obsidian/index.html +++ b/notes/obsidian/index.html @@ -1,40 +1,11 @@ Obsidian Vault Integration - +

          -

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search
          +

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search

          Obsidian Vault Integration

          Last updated April 17, 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 use 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 recommend [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

          +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 use 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 recommend [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/2/index.html b/notes/page/2/index.html index 114604d5d..560c8571d 100644 --- a/notes/page/2/index.html +++ b/notes/page/2/index.html @@ -1,39 +1,9 @@ Notes - +
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search

        All Notes

        • 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

        • 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 2, 2022

        diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html index 8ec6dbbcf..0425372ba 100644 --- a/notes/philosophy/index.html +++ b/notes/philosophy/index.html @@ -1,43 +1,14 @@ Quartz Philosophy - +
        -

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search
        +

        πŸͺ΄ Quartz 3.2

        Search IconIcon to open search

        Quartz Philosophy

        Last updated November 20, 2021

          β€œ[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. 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

          +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 d7c929753..138b42f1a 100644 --- a/notes/preview-changes/index.html +++ b/notes/preview-changes/index.html @@ -1,39 +1,9 @@ Preview Changes - +
          -

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search
          +

          πŸͺ΄ Quartz 3.2

          Search IconIcon to open search

          Preview Changes

          Last updated March 4, 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
@@ -66,5 +36,6 @@
 $ hugo server
 
 # View your site in a browser at http://localhost:1313/
-

            Backlinks

            Interactive Graph

            +

            Backlinks

            Interactive Graph

            +
            \ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index 710ef7056..d773f2608 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,39 +1,9 @@ Setup - +
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search
            +

            πŸͺ΄ 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 @@ -63,5 +33,6 @@ Make sure you have a copy of these changes if you don’t want to lose them. # 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

            +

            Backlinks

            Interactive Graph

            +
            \ No newline at end of file diff --git a/notes/showcase/index.html b/notes/showcase/index.html index c6d7063c8..3cfdd0f1d 100644 --- a/notes/showcase/index.html +++ b/notes/showcase/index.html @@ -2,39 +2,10 @@ 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!">Showcase - +
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search
            +

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search

            Backlinks

            Interactive Graph

            +Pull Request adding yourself to this file!

            Backlinks

            Interactive Graph

            +
            \ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 627f70e5d..ceffd91fe 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -2,39 +2,9 @@ While you’re here, join our Discord :)">Troubleshooting and FAQ - +
            -

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search
            +

            πŸͺ΄ Quartz 3.2

            Search IconIcon to open search

            Troubleshooting and FAQ

            Last updated April 2, 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 @@ -73,5 +43,6 @@ While you’re here, join our Discord :)">Troubleshooting and FAQ</ti </span></span></code></pre></td></tr></table></div></div><a href=#my-interactive-graph-and-backlinks-arent-up-to-date><h3 id=my-interactive-graph-and-backlinks-arent-up-to-date><span class=hanchor arialabel=Anchor># </span>My Interactive Graph and Backlinks aren’t up to date</h3></a><p>By default, the <code>linkIndex.json</code> (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on <a href=/notes/editing/ rel=noopener class=internal-link data-src=/notes/editing/>local editing</a></p><a href=#can-i-use-reactvuesome-other-framework><h3 id=can-i-use-reactvuesome-other-framework><span class=hanchor arialabel=Anchor># </span>Can I use React/Vue/some other framework?</h3></a><p>Not out of the box. You could probably make it work by editing <code>/layouts/_default/single.html</code> 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.</p><a href=#still-stuck><h2 id=still-stuck><span class=hanchor arialabel=Anchor># </span>Still Stuck?</h2></a><p>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 <a href=https://twitter.com/_jzhao rel=noopener>Twitter</a> and I’ll try to get back to you as soon as I can.</p><p>πŸ› -<a href=https://github.com/jackyzha0/quartz/issues rel=noopener>Submit an Issue</a></p></article><hr><div class=page-end><div class=backlinks-container><h3>Backlinks</h3><ul class=backlinks><li><a href=//>πŸͺ΄ Quartz 3.2</a></li><li><a href=/notes/config/>Configuration</a></li><li><a href=/notes/editing/>Editing Content in Quartz</a></li><li><a href=/notes/hosting/>Deploying Quartz to the Web</a></li><li><a href=/notes/setup/>Setup</a></li></ul></div><div><script src=https://cdn.jsdelivr.net/npm/d3@6.7.0/dist/d3.min.js integrity="sha256-+7jaYCp29O1JusNWHaYtgUn6EhuP0VaFuswhNV06MyI=" crossorigin=anonymous></script><h3>Interactive Graph</h3><div id=graph-container></div><style>:root{--g-node:var(--secondary);--g-node-active:var(--primary);--g-node-inactive:var(--visited);--g-link:var(--outlinegray);--g-link-active:#5a7282}</style><script src=https://quartz.jzhao.xyz/js/graph.dfc818c40e5b3ddf1172c39e0c8f62fc.js></script></div></div><div id=contact_buttons><footer><p>Made by Jacky Zhao using <a href=https://github.com/jackyzha0/quartz>Quartz</a>, Β© 2022</p><ul><li><a href=/>Home</a></li><li><a href=https://twitter.com/_jzhao>Twitter</a></li><li><a href=https://github.com/jackyzha0>Github</a></li></ul></footer></div><script src=https://quartz.jzhao.xyz/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js></script> +<a href=https://github.com/jackyzha0/quartz/issues rel=noopener>Submit an Issue</a></p></article><hr><div class=page-end><div class=backlinks-container><h3>Backlinks</h3><ul class=backlinks><li><a href=/>πŸͺ΄ Quartz 3.2</a></li><li><a href=/notes/config/>Configuration</a></li><li><a href=/notes/editing/>Editing Content in Quartz</a></li><li><a href=/notes/hosting/>Deploying Quartz to the Web</a></li><li><a href=/notes/setup/>Setup</a></li></ul></div><div><script src=https://cdn.jsdelivr.net/npm/d3@6.7.0/dist/d3.min.js integrity="sha256-+7jaYCp29O1JusNWHaYtgUn6EhuP0VaFuswhNV06MyI=" crossorigin=anonymous></script><h3>Interactive Graph</h3><div id=graph-container></div><style>:root{--g-node:var(--secondary);--g-node-active:var(--primary);--g-node-inactive:var(--visited);--g-link:var(--outlinegray);--g-link-active:#5a7282}</style><script src=https://quartz.jzhao.xyz/js/graph.dfc818c40e5b3ddf1172c39e0c8f62fc.js></script> +<script>drawGraph("https://quartz.jzhao.xyz/notes/troubleshooting","https://quartz.jzhao.xyz",[{"/moc":"#4388cc"}],-1,!0,!1,!0)</script></div></div><div id=contact_buttons><footer><p>Made by Jacky Zhao using <a href=https://github.com/jackyzha0/quartz>Quartz</a>, Β© 2022</p><ul><li><a href=/>Home</a></li><li><a href=https://twitter.com/_jzhao>Twitter</a></li><li><a href=https://github.com/jackyzha0>Github</a></li></ul></footer></div><script src=https://quartz.jzhao.xyz/js/popover.e57188d2e4c06b0654e020b3a734bb62.min.js></script> <script>initPopover("https://quartz.jzhao.xyz")</script></div></body></html> \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index b304c6037..f437b4ced 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,38 +1,8 @@ <!doctype html><html lang=en><head><meta charset=utf-8><meta name=description content><title>Tags - +

              -

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search
              +

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search

              All Tags

              setup

              5 notes with this tag (showing first 2 results)

              • 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 17, 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/index.html b/tags/setup/index.html index 0049eaa32..8d629400e 100644 --- a/tags/setup/index.html +++ b/tags/setup/index.html @@ -1,39 +1,9 @@ setup - +
              -

              πŸͺ΄ Quartz 3.2

              Search IconIcon to open search
              +

              πŸͺ΄ 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 2, 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 February 17, 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 3, 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 17, 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