diff --git a/404.html b/404.html index 44e1f1c66..f91839bd0 100644 --- a/404.html +++ b/404.html @@ -1,2 +1,2 @@ -404 Page not found
-

404.

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

ā†³ Let's get you home.
\ No newline at end of file +404 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/index.html b/index.html index b4f539ead..4dbbc576a 100644 --- a/index.html +++ b/index.html @@ -1,16 +1,16 @@ -šŸŖ“ Quartz v2.1

šŸŖ“ Quartz v2.1

Search IconIcon to open search
+
`;else{results.innerHTML=b.map(a=>resultToHTML({...a,term})).join("\n");const a=document.getElementsByClassName("result-card");[...a].forEach(a=>{a.onclick=()=>redir(a.id,term)})}})});const searchContainer=document.getElementById("search-container");function openSearch(){searchContainer.style.display==="none"||searchContainer.style.display===""?(source.value="",results.innerHTML="",searchContainer.style.display="block",source.focus()):searchContainer.style.display="none"}function closeSearch(){searchContainer.style.display="none"}document.addEventListener('keydown',a=>{a.key==="/"&&(a.preventDefault(),openSearch()),a.key==="Escape"&&(a.preventDefault(),closeSearch())}),window.addEventListener('DOMContentLoaded',()=>{const a=document.getElementById("search-icon");a.addEventListener('click',a=>{openSearch()}),a.addEventListener('keydown',a=>{openSearch()}),searchContainer.addEventListener('click',a=>{closeSearch()}),document.getElementById("search-space").addEventListener('click',a=>{a.stopPropagation()})})

šŸŖ“ Quartz 3

Search IconIcon to open search

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

  1. Extremely fast full-text search by pressing /
  2. Beautiful, out-of-the-box website creation and deployment
  3. Display for backlinks of each note
  4. A customizable graph view
  5. Endlessly powerful page and theme customization

Get Started

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

Not convinced yet? Look at some -community digital gardens +Setup your own digital garden using Quartz

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

Troubleshooting

Backlinks

  • No backlinks found

Interactive Graph

\ No newline at end of file +Troubleshooting and FAQ
  • šŸ› +Submit an Issue

    • Backlinks

    • No backlinks found

    Interactive Graph

    \ No newline at end of file diff --git a/index.xml b/index.xml index 25dba5b05..a0c5021ad 100644 --- a/index.xml +++ b/index.xml @@ -1,10 +1,10 @@ -šŸŖ“ Quartz v2.1 onhttps://quartz.jzhao.xyz/Recent content in šŸŖ“ Quartz v2.1 onHugo -- gohugo.ioen-usConfigurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get. +šŸŖ“ Quartz 3 onhttps://quartz.jzhao.xyz/Recent content in šŸŖ“ Quartz 3 onHugo -- gohugo.ioen-usConfigurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get. The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below. 1 2 3 4 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live. 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 ActionsEditing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown . Obsidian I strongly recommend using Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files. -šŸ”— How to link your Obsidian Vault +šŸ”— How to link your Obsidian Vault](notes/Obsidian.md) Of course, all the files are in Markdown so you could just use your favourite text editor of choice.Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered. 1 2 3 4 5 6 ... ignoreFiles = [ "/content/templates/*", "/content/private/*", "<your path here>" ] ignoreFiles supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all .pngs by doing \\.png$). To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. 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 . diff --git a/moc/showcase/index.html b/moc/showcase/index.html index f096168c3..2165c7c50 100644 --- a/moc/showcase/index.html +++ b/moc/showcase/index.html @@ -1,10 +1,10 @@ -Showcase

    šŸŖ“ Quartz v3

    Search IconIcon to open search

    Backlinks

    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2021

    Home +!

    Backlinks

    Interactive Graph

    \ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index 7ade0b144..612b003fb 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,7 +1,7 @@ -Configuration

    šŸŖ“ Quartz v3

    Search IconIcon to open search

    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.

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

     1
@@ -36,6 +36,6 @@
   - /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

    More info about partials on Hugo’s website.

    Still having problems? Checkout our -FAQ and Troubleshooting guide -.

    Backlinks

    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2021

    Home +FAQ and Troubleshooting guide +.

    Backlinks

    Interactive Graph

    \ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index 6e360160c..a450f6469 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,7 +1,7 @@ -Editing Content in Quartz

    šŸŖ“ Quartz v3

    Search IconIcon to open search

    Editing Content in Quartz

    Editing

    Quartz runs on top of @@ -10,9 +10,8 @@ so all notes are written in Markdown .

    Obsidian

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

    šŸ”— -How to link your Obsidian Vault

    Of course, all the files are in Markdown so you could just use your favourite text editor of choice.

    Ignoring Files

    Only want to publish a subset of all of your notes? Don’t worry, Quartz makes this a simple two-step process.

    āŒ -Excluding pages from being published

    Folder Structure

    Here’s a rough overview of what’s what.

    All content in your garden can found in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you’d like.

    To edit the main home page, open /content/_index.md. This is the home page which is slightly special. You don’t need front matter here!

    To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that all links should be relative to the root /content path.

    1
+as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files.
    šŸ”— How to link your Obsidian Vault](notes/Obsidian.md)
    Of course, all the files are in Markdown so you could just use your favourite text editor of choice.
    Ignoring Files
    Only want to publish a subset of all of your notes? Don’t worry, Quartz makes this a simple two-step process.
    āŒ
+Excluding pages from being published
    Folder Structure
    Here’s a rough overview of what’s what.
    All content in your garden can found in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you’d like.
    To edit the main home page, open /content/_index.md. This is the home page which is slightly special. You don’t need front matter here!
    To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that all links should be relative to the root /content path.
    1
 2
 
    For example, I want to link this current document to `notes/config.md`.
 [A link to the config page](notes/config.md)
@@ -27,8 +26,8 @@ title: "Example Title"
 
 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.
    šŸ‘€
-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
    Made by Jacky Zhao using Quartz, Ā© 2021
    Home
+Preview Quartz Changes
    For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
    Publishing Changes
    Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
    šŸŒ
+Hosting Quartz online!
    Having problems? Checkout our
+FAQ and Troubleshooting guide
+.
    Backlinks
    Interactive Graph
    
\ No newline at end of file
diff --git a/notes/hosting/index.html b/notes/hosting/index.html
index 99f777b01..56740584f 100644
--- a/notes/hosting/index.html
+++ b/notes/hosting/index.html
@@ -1,10 +1,10 @@
-Deploying Quartz to the Web
    šŸŖ“ Quartz v3
    Search IconIcon to open search
    
-
    Deploying Quartz to the Web
    GitHub Pages
    Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
    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. Set the source to deploy from master 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 essentially a git repository so updating it is the same workflow as you would follow as normal.
    1
+
    Deploying Quartz to the Web
    GitHub Pages
    Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
    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. Set the source to deploy from master 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 essentially a git repository so updating it is the same workflow as you would follow as normal.
    1
 2
 3
 4
@@ -42,8 +42,8 @@ git push origin hugo
 	cname: <YOUR-DOMAIN>
 
    Registrar
    This step is only applicable if you are using a custom domain! If you are using <YOUR-USERNAME>.github.io, 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!
    External Hosting
    Don’t want to use GitHub Pages? Hugo builds everything for you! Everything is a packaged set of static files ready to deploy in /public. You can then upload this folder to a cloud provider to deploy. Alternatively, most providers also give users the option to link a GitHub repository and a folder to deploy. When doing this, ensure you select /public folder under the master branch.
    Now that your Quartz is live, let’s figure out how to make Quartz really yours!
    šŸŽØ
-Customizing Quartz
    Having problems? Checkout our
-FAQ and Troubleshooting guide
-.
    Backlinks
    Interactive Graph
    Made by Jacky Zhao using Quartz, Ā© 2021
    Home
+, 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!
    External Hosting
    Don’t want to use GitHub Pages? Hugo builds everything for you! Everything is a packaged set of static files ready to deploy in /public. You can then upload this folder to a cloud provider to deploy. Alternatively, most providers also give users the option to link a GitHub repository and a folder to deploy. When doing this, ensure you select /public folder under the master branch.
    Now that your Quartz is live, let’s figure out how to make Quartz really yours!
    šŸŽØ
+Customizing Quartz
    Having problems? Checkout our
+FAQ and Troubleshooting guide
+.
    Backlinks
    Interactive Graph
    
\ No newline at end of file
diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html
index 23eb91ee7..175f93e22 100644
--- a/notes/ignore-notes/index.html
+++ b/notes/ignore-notes/index.html
@@ -1,7 +1,7 @@
-Ignoring Notes
    šŸŖ“ Quartz v3
    Search IconIcon to open search
    
 
    Ignoring Notes
    Quartz Ignore
    Edit ignoreFiles in config.toml to include paths you’d like to exclude from being rendered.
    1
@@ -29,5 +29,5 @@ draft: true
 ...
 
    More details in
 Hugo’s documentation
-.
    Global Ignore
    However, just adding to the ignoreFiles will only prevent the page from being access through Quartz. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the .gitignore file at the root of the repository.
    Backlinks
    Interactive Graph
    Made by Jacky Zhao using Quartz, Ā© 2021
    Home
+.
    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.xml b/notes/index.xml
index e60b978a3..9e4bfd6c2 100644
--- a/notes/index.xml
+++ b/notes/index.xml
@@ -4,7 +4,7 @@ The majority of configuration can be be found under data/config.yaml. An annotat
 Enable GitHub Actions By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the &lsquo;Actions&rsquo; tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
 Enable GitHub ActionsEditing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown .
 Obsidian I strongly recommend using Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files.
-šŸ”— How to link your Obsidian Vault
+šŸ”— How to link your Obsidian Vault](notes/Obsidian.md)
 Of course, all the files are in Markdown so you could just use your favourite text editor of choice.Ignoring Noteshttps://quartz.jzhao.xyz/notes/ignore-notes/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/ignore-notes/Quartz Ignore Edit ignoreFiles in config.toml to include paths you&rsquo;d like to exclude from being rendered.
 1 2 3 4 5 6 ... ignoreFiles = [ &#34;/content/templates/*&#34;, &#34;/content/private/*&#34;, &#34;&lt;your path here&gt;&#34; ] ignoreFiles supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all .pngs by doing \\.png$). To ignore a specific file, you can also add the tag draft: true to the frontmatter of a note.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
 New Vault If you don&rsquo;t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the setup .
diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html
index 1a415a0e0..6d9b7ccbf 100644
--- a/notes/obsidian/index.html
+++ b/notes/obsidian/index.html
@@ -1,12 +1,12 @@
-Obsidian Vault Integration
    šŸŖ“ Quartz v3
    Search IconIcon to open search
    
 
    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.
    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
-.
    Linking an existing Vault
    The easiest way to use an existing Vault is to copy all of our 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.
    Obsidian SettingsObsidian Settings
    Templates
    Inserting front matter everytime you want to create a new Note gets really 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’. 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
    Made by Jacky Zhao using Quartz, Ā© 2021
    Home
+setup
+.
    Linking an existing Vault
    The easiest way to use an existing Vault is to copy all of our 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.
    Obsidian SettingsObsidian Settings
    Templates
    Inserting front matter everytime you want to create a new Note gets really 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’. That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
    Backlinks
    • No backlinks found
    Interactive Graph
    
\ No newline at end of file
diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html
index bc4106605..7b2f8d46b 100644
--- a/notes/philosophy/index.html
+++ b/notes/philosophy/index.html
@@ -1,7 +1,7 @@
-Quartz Philosophy
    šŸŖ“ Quartz v3
    Search IconIcon to open search
    
 
    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
@@ -14,5 +14,5 @@
 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
    Made by Jacky Zhao using Quartz, Ā© 2021
    Home
+’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 7dba3a2cb..085e42aa1 100644
--- a/notes/preview-changes/index.html
+++ b/notes/preview-changes/index.html
@@ -1,7 +1,7 @@
-Preview Changes
    šŸŖ“ Quartz v3
    Search IconIcon to open search
    
 
    Preview Changes
    If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!
    Install hugo-obsidian
    This step will generate the list of backlinks for Hugo to parse. Ensure you have
@@ -38,5 +38,5 @@ $ cd <location-of-your-local-quartz>
 $ 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 3a3971d05..eaf9d2165 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,7 +1,7 @@ -Setup

    šŸŖ“ Quartz v3

    Search IconIcon to open search

    Setup

    Making your own Quartz

    Setting up Quartz requires a basic understanding of git. If you are unfamiliar, @@ -14,7 +14,7 @@ is a great place to start!

    Forking

    A fork i .

    Cloning

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

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

    Editing

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

    āœļø -Editing Notes in Quartz

    Having problems? Checkout our -FAQ and Troubleshooting guide -.

    Backlinks

    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2021

    Home +Editing Notes in Quartz

    Having problems? Checkout our +FAQ and Troubleshooting guide +.

    Backlinks

    Interactive Graph

    \ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 10cd48bbc..98878c0c0 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,13 +1,13 @@ -Troubleshooting and FAQ

    šŸŖ“ Quartz v3

    Search IconIcon to open search

    Troubleshooting and FAQ

    Common Pitfalls

    Can I publish only a subset of my pages?

    Yes! Quartz makes selective publishing really easy. Heres a guide on -excluding pages from being published +excluding pages from being published .

    Can I host this myself and not on GitHub Pages?

    Yes! All built files can be found under /public in the master branch. More details under -hosting +hosting .

    Do I need a website already?

    No! Setting up Quartz means you set up a site too :)

    command not found: hugo-obsidian

    Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.

    1
 2
 3
@@ -21,20 +21,20 @@
 # In your current terminal, to reload the session
 source ~/.bash_profile

    How come my notes aren’t being rendered?

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

    My custom domain isn’t working!

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

    How do I setup Google Analytics?

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

    How do I change the content on the home page?

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

    How do I change the colours?

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

    How do I add images?

    You 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 /.

    1
 2
 
    Example image (source is in content/notes/images/example.png)
 ![Example Image](/content/notes/images/example.png)

    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 +local editing

    Can I use React/Vue/some other framework?

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

    Still Stuck?

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

    šŸ› -Submit an Issue

    Backlinks

    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2021

    Home +Submit an Issue

    Backlinks

    Interactive Graph

    \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 3e5eb1e68..4fe1a3c2a 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/https://quartz.jzhao.xyz/notes/hosting/https://quartz.jzhao.xyz/notes/editing/https://quartz.jzhao.xyz/notes/ignore-notes/https://quartz.jzhao.xyz/moc/https://quartz.jzhao.xyz/notes/https://quartz.jzhao.xyz/notes/obsidian/https://quartz.jzhao.xyz/notes/preview-changes/https://quartz.jzhao.xyz/notes/philosophy/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/moc/showcase/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/https://quartz.jzhao.xyz/ \ No newline at end of file +https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/https://quartz.jzhao.xyz/notes/hosting/https://quartz.jzhao.xyz/notes/editing/https://quartz.jzhao.xyz/notes/ignore-notes/https://quartz.jzhao.xyz/moc/https://quartz.jzhao.xyz/notes/https://quartz.jzhao.xyz/notes/obsidian/https://quartz.jzhao.xyz/notes/preview-changes/https://quartz.jzhao.xyz/notes/philosophy/https://quartz.jzhao.xyz/notes/setup/https://quartz.jzhao.xyz/tags/setup/https://quartz.jzhao.xyz/moc/showcase/https://quartz.jzhao.xyz/tags/https://quartz.jzhao.xyz/notes/troubleshooting/https://quartz.jzhao.xyz/ \ No newline at end of file diff --git a/tags/index.xml b/tags/index.xml index c5496c097..4b8761055 100644 --- a/tags/index.xml +++ b/tags/index.xml @@ -1 +1 @@ -Tags onhttps://quartz.jzhao.xyz/tags/Recent content in Tags onHugo -- gohugo.ioen-us \ No newline at end of file +Tags onhttps://quartz.jzhao.xyz/tags/Recent content in Tags onHugo -- gohugo.ioen-ussetuphttps://quartz.jzhao.xyz/tags/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/tags/setup/ \ No newline at end of file diff --git a/tags/setup/index.xml b/tags/setup/index.xml new file mode 100644 index 000000000..dbb46f7f1 --- /dev/null +++ b/tags/setup/index.xml @@ -0,0 +1,13 @@ +setup onhttps://quartz.jzhao.xyz/tags/setup/Recent content in setup onHugo -- gohugo.ioen-usConfigurationhttps://quartz.jzhao.xyz/notes/config/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/config/Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you&rsquo;d like to get. +The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below. +1 2 3 4 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.Deploying Quartz to the Webhttps://quartz.jzhao.xyz/notes/hosting/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/hosting/GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to &lt;YOUR-GITHUB-USERNAME.github.io/quartz to see it live. +Enable GitHub Actions By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the &lsquo;Actions&rsquo; tab of your forked repository and Enable Workflows to setup deploying your Quartz site! +Enable GitHub ActionsEditing Content in Quartzhttps://quartz.jzhao.xyz/notes/editing/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/editing/Editing Quartz runs on top of Hugo so all notes are written in Markdown . +Obsidian I strongly recommend using Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files. +šŸ”— How to link your Obsidian Vault](notes/Obsidian.md) +Of course, all the files are in Markdown so you could just use your favourite text editor of choice.Obsidian Vault Integrationhttps://quartz.jzhao.xyz/notes/obsidian/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/obsidian/Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. +New Vault If you don&rsquo;t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the setup . +Linking an existing Vault The easiest way to use an existing Vault is to copy all of our files (directory and hierarchies intact) into the /content folder.Setuphttps://quartz.jzhao.xyz/notes/setup/Mon, 01 Jan 0001 00:00:00 +0000https://quartz.jzhao.xyz/notes/setup/Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start! +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. \ No newline at end of file