\ No newline at end of file
diff --git a/categories/index.html b/categories/index.html
index c41920dc3..e3d97b6c9 100644
--- a/categories/index.html
+++ b/categories/index.html
@@ -1,12 +1,12 @@
-Categories
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 February 15, 2022
\ No newline at end of file
diff --git a/contentIndex.json b/contentIndex.json
new file mode 100644
index 000000000..73f66782a
--- /dev/null
+++ b/contentIndex.json
@@ -0,0 +1,92 @@
+{
+ "/": {
+ "title": "šŖ“ Quartz 3.1",
+ "content": "Host your second brain and [digital garden](https://jzhao.xyz/posts/digital-gardening) for free. Quartz features\n1. Extremely fast full-text search by pressing `/`\n2. Display for backlinks of each note\n3. Fully customizable local graph view\n4. Endlessly powerful page and theme customization using CSS\n5. Automatically generated tag and section lists of content\n6. Beautiful link previews\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-02-16T00:43:28.008917961Z",
+ "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 be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n3. Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)\n\n*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-02-16T00:43:28.008917961Z",
+ "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/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).",
+ "lastmodified": "2022-02-16T00:43:28.008917961Z",
+ "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*\n3. Wait 30 minutes to an hour for the network changes to kick in.\n4. Done!",
+ "lastmodified": "2022-02-16T00:43:28.008917961Z",
+ "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`.** This is the home page which is slightly special. You don't need front matter here!\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. The only caveat is that you should reference them in your Markdown by prefixing it with a `/`.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n\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-02-16T00:43:28.008917961Z",
+ "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*\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` using `/ (root)`\n2. Set a custom domain here if you have one!\n\n*Enable GitHub Pages*\n\n### Pushing Changes\nTo see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a `git` repository so updating it is the same workflow as you would follow as normal.\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\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 path.\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\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-02-16T00:43:28.008917961Z",
+ "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-02-16T00:43:28.008917961Z",
+ "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 be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.\n2. Go to Settings \u003e Files \u0026 Links \u003e Turn \"on\" automatically update internal links.\n3. Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)\n\n*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-02-16T00:43:28.012917961Z",
+ "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-02-16T00:43:28.012917961Z",
+ "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\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=data -index -root=.\n```\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-02-16T00:43:28.012917961Z",
+ "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).",
+ "lastmodified": "2022-02-16T00:43:28.012917961Z",
+ "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\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/moc/showcase.md)!",
+ "lastmodified": "2022-02-16T00:43:28.012917961Z",
+ "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### 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### Do I need a website already?\nNo! Setting up Quartz means you set up a site too :)\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. The only caveat is that you should reference them in your Markdown by prefixing it with a `/`.\n\n```markdown\nExample image (source is in content/notes/images/example.png)\n\n```\n\n### My Interactive Graph and Backlinks aren't up to date\nBy default, the `linkIndex.yaml` (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-02-16T00:43:28.012917961Z",
+ "tags": null
+ },
+ "/private/private-note": {
+ "title": "Private Stuff",
+ "content": "This page doesn't get published!",
+ "lastmodified": "2022-02-16T00:43:28.012917961Z",
+ "tags": null
+ },
+ "/templates/post": {
+ "title": "{{title}}",
+ "content": "",
+ "lastmodified": "2022-02-16T00:43:28.012917961Z",
+ "tags": null
+ }
+}
\ No newline at end of file
diff --git a/index.html b/index.html
index 56a05dbca..823242465 100644
--- a/index.html
+++ b/index.html
@@ -1,13 +1,13 @@
-šŖ“ Quartz 3
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
@@ -44,5 +44,5 @@
- /moc:"#4388cc"
Styling
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing assets/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
\ No newline at end of file
diff --git a/notes/custom-Domain/index.html b/notes/custom-Domain/index.html
index 254bcf30e..e79720bc2 100644
--- a/notes/custom-Domain/index.html
+++ b/notes/custom-Domain/index.html
@@ -1,13 +1,13 @@
-Custom Domain
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).
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.
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 Quartz
Wait 30 minutes to an hour for the network changes to kick in.
\ No newline at end of file
diff --git a/notes/editing/index.html b/notes/editing/index.html
index e34c059d8..d699114db 100644
--- a/notes/editing/index.html
+++ b/notes/editing/index.html
@@ -1,14 +1,14 @@
Editing Content in Quartz
Quartz runs on top of
Hugo so all notes are written in
Markdown.
Obsidian
I recommend using
@@ -41,5 +41,5 @@ 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.
\ No newline at end of file
diff --git a/notes/hosting/index.html b/notes/hosting/index.html
index 4172672cc..dd23a19bb 100644
--- a/notes/hosting/index.html
+++ b/notes/hosting/index.html
@@ -1,13 +1,13 @@
-Deploying Quartz to the Web
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 Actions
Enable GitHub Pages
Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
(IMPORTANT) Set the source to deploy from master using / (root)
Set a custom domain here if you have one!
Enable GitHub Pages
Pushing Changes
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a git repository so updating it is the same workflow as you would follow as normal.
\ No newline at end of file
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
index 22b826f70..a9d9c5732 100644
--- a/notes/ignore-notes/index.html
+++ b/notes/ignore-notes/index.html
@@ -1,14 +1,14 @@
Ignoring Notes
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.
\ No newline at end of file
diff --git a/notes/index.html b/notes/index.html
index 610581aba..80cee13e6 100644
--- a/notes/index.html
+++ b/notes/index.html
@@ -1,13 +1,13 @@
-Notes
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 If you want to see your own on here, submit a Pull Request adding yourself to this file!...
ā[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....
Editing Quartz runs on top of Hugo so all notes are written in Markdown.
diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html
index 0b4236bab..7519f521c 100644
--- a/notes/obsidian/index.html
+++ b/notes/obsidian/index.html
@@ -1,14 +1,14 @@
-
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.
Under Options > Files and Links, set the New link format to always be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
Go to Settings > Files & Links > Turn “on” automatically update internal links.
Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)
Obsidian 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!
\ No newline at end of file
diff --git a/notes/page/2/index.html b/notes/page/2/index.html
index 4fa0fa483..0cc325cf2 100644
--- a/notes/page/2/index.html
+++ b/notes/page/2/index.html
@@ -1,13 +1,13 @@
-Notes
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/notes/philosophy/index.html b/notes/philosophy/index.html
index cf53c16f4..7f5c516eb 100644
--- a/notes/philosophy/index.html
+++ b/notes/philosophy/index.html
@@ -1,17 +1,17 @@
-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.ā ā 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
It’s nice to access notes from anywhere
Having a public digital garden invites open conversations
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.
\ No newline at end of file
diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html
index 19c011238..85ff9794c 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,13 +1,13 @@
-Preview Changes
\ No newline at end of file
diff --git a/notes/setup/index.html b/notes/setup/index.html
index d1de89ef8..e72576691 100644
--- a/notes/setup/index.html
+++ b/notes/setup/index.html
@@ -1,13 +1,13 @@
-Setup
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.
\ No newline at end of file
diff --git a/notes/showcase/index.html b/notes/showcase/index.html
index 993e46391..e7b44260d 100644
--- a/notes/showcase/index.html
+++ b/notes/showcase/index.html
@@ -1,14 +1,14 @@
Showcase
\ No newline at end of file
diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html
index b00082098..ca267fb4a 100644
--- a/notes/troubleshooting/index.html
+++ b/notes/troubleshooting/index.html
@@ -1,14 +1,14 @@
Troubleshooting and FAQ
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.
My Interactive Graph and Backlinks aren’t up to date
By default, the linkIndex.yaml (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.
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 1e23b409a..dfb032f70 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/hosting/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/editing/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/obsidian/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/preview-changes/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/philosophy/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/setup/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/tags/setup/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/showcase/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/tags/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-02-15T17:12:08-05:00https://quartz.jzhao.xyz/2022-02-15T17:12:08-05:00
\ No newline at end of file
+https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/custom-Domain/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/hosting/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/editing/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/obsidian/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/preview-changes/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/philosophy/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/setup/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/tags/setup/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/showcase/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/tags/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-02-15T19:42:45-05:00https://quartz.jzhao.xyz/2022-02-15T19:42:45-05:00
\ No newline at end of file
diff --git a/tags/index.html b/tags/index.html
index e7918bc69..35cfab360 100644
--- a/tags/index.html
+++ b/tags/index.html
@@ -1,12 +1,12 @@
-Tags
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 February 15, 2022
\ No newline at end of file
diff --git a/tags/setup/index.html b/tags/setup/index.html
index 969f0cd90..c1eec65d1 100644
--- a/tags/setup/index.html
+++ b/tags/setup/index.html
@@ -1,13 +1,13 @@
-setup
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....
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 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....
Example Configuration for Quartz
Enable GitHub Actions
Enable GitHub Pages
Obsidian Settings