From 01bd224545c23557848268e53128590f5d652480 Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Thu, 6 Jan 2022 00:43:06 +0000 Subject: [PATCH] deploy: 532bc610254db096807453bf223acaa91634fd81 --- 404.html | 4 ++-- categories/index.html | 4 ++-- custom-Domain/index.html | 4 ++-- index.html | 10 +++++----- notes/config/index.html | 6 +++--- notes/editing/index.html | 14 +++++++------- notes/hosting/index.html | 10 +++++----- notes/ignore-notes/index.html | 6 +++--- notes/index.html | 10 +++++----- notes/obsidian/index.html | 6 +++--- notes/philosophy/index.html | 6 +++--- notes/preview-changes/index.html | 6 +++--- notes/setup/index.html | 8 ++++---- notes/showcase/index.html | 6 +++--- notes/troubleshooting/index.html | 20 ++++++++++---------- sitemap.xml | 2 +- tags/index.html | 4 ++-- tags/setup/index.html | 6 +++--- 18 files changed, 66 insertions(+), 66 deletions(-) diff --git a/404.html b/404.html index f2e0ebd49..04a14764c 100644 --- a/404.html +++ b/404.html @@ -1,5 +1,5 @@ -404 Page not found
-

404.

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

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

404.

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

↳ Let's get you home.
\ No newline at end of file diff --git a/categories/index.html b/categories/index.html index c51507a70..01d5a7d5f 100644 --- a/categories/index.html +++ b/categories/index.html @@ -1,4 +1,4 @@ -Categories

🪓 Quartz 3

Search IconIcon to open search
-

All Categories

setup

5 notes with this tag (showing first 2 results)

  • Setup

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

    1 minute read. Last updated January 4, 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 January 4, 2022

Made by Jacky Zhao using Quartz, Ā© 2022

Home +

All Categories

setup

5 notes with this tag (showing first 2 results)

  • Setup

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

    1 minute read. Last updated January 5, 2022

  • Obsidian Vault Integration

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

    2 minute read. Last updated January 5, 2022

\ No newline at end of file diff --git a/custom-Domain/index.html b/custom-Domain/index.html index ecf36bbfe..14f570ca6 100644 --- a/custom-Domain/index.html +++ b/custom-Domain/index.html @@ -1,4 +1,4 @@ -🪓 Quartz 3

🪓 Quartz 3

Search IconIcon to open search

Last updated Unknown

    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!


    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2022

    Home +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!


    Interactive Graph

    \ No newline at end of file diff --git a/index.html b/index.html index dfdca4a2c..1399ffb7f 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -🪓 Quartz 3

    🪓 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. Display for backlinks of each note
    3. Fully customizable local graph view
    4. Endlessly powerful page and theme customization using CSS
    5. Automatically generated tag and section lists of content
    6. Beautiful link previews

    Get Started

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

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

    Content Lists

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

    Troubleshooting


    Interactive Graph

    \ No newline at end of file diff --git a/notes/config/index.html b/notes/config/index.html index effbec18c..b668822ab 100644 --- a/notes/config/index.html +++ b/notes/config/index.html @@ -1,4 +1,4 @@ -Configuration

    🪓 Quartz 3

    Search IconIcon to open search
    -

    Configuration

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

    Configuration

    Last updated January 5, 2022

    Configuration

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

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

     1
      2
      3
      4
    @@ -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

    More info about partials on Hugo’s website.

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


    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2022

    Home +FAQ and Troubleshooting guide.


    Interactive Graph

    \ No newline at end of file diff --git a/notes/editing/index.html b/notes/editing/index.html index 138cb81fd..05677544d 100644 --- a/notes/editing/index.html +++ b/notes/editing/index.html @@ -1,5 +1,5 @@ Editing Content in Quartz

    🪓 Quartz 3

    Search IconIcon to open search
    -

    Editing Content in Quartz

    Last updated January 5, 2022

    Editing

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

    Obsidian

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

    This step is highly recommended.

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

    Ignoring Files

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

    āŒ -Excluding pages from being published

    Folder Structure

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

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

    To edit the main home page, open /content/_index.md. 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
    +How to setup your Obsidian Vault to work with Quartz

    Ignoring Files

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

    āŒ +Excluding pages from being published

    Folder Structure

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

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

    To edit the main home page, open /content/_index.md. 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)
    @@ -37,7 +37,7 @@ tags:
     
     Rest of your content here...
     

    Previewing Changes

    This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is highly recommended but not required.

    šŸ‘€ -Preview Quartz Changes

    For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.

    Publishing Changes

    Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!

    šŸŒ -Hosting Quartz online!

    Having problems? Checkout our -FAQ and Troubleshooting guide.


    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2022

    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.


    Interactive Graph

    \ No newline at end of file diff --git a/notes/hosting/index.html b/notes/hosting/index.html index 6deeaa196..7e3f90f2c 100644 --- a/notes/hosting/index.html +++ b/notes/hosting/index.html @@ -1,4 +1,4 @@ -Deploying Quartz to the Web

    🪓 Quartz 3

    Search IconIcon to open search
    -

    Deploying Quartz to the Web

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

    Last updated January 5, 2022

    GitHub Pages

    Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.

    Enable GitHub Actions

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

    Enable GitHub ActionsEnable GitHub Actions

    Enable GitHub Pages

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

    1. (IMPORTANT) Set the source to deploy from master 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
    @@ -45,7 +45,7 @@ git push origin hugo
     	publish_branch: master
     	cname: <YOUR-DOMAIN>
     

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


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

    šŸŽØ -Customizing Quartz

    Having problems? Checkout our -FAQ and Troubleshooting guide.


    Interactive Graph

    Made by Jacky Zhao using Quartz, Ā© 2022

    Home +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.


    Interactive Graph

    \ No newline at end of file diff --git a/notes/ignore-notes/index.html b/notes/ignore-notes/index.html index 6a617a2f4..f3e90bc97 100644 --- a/notes/ignore-notes/index.html +++ b/notes/ignore-notes/index.html @@ -1,5 +1,5 @@ Ignoring Notes

    🪓 Quartz 3

    Search IconIcon to open search
    -

    Ignoring Notes

    Last updated January 4, 2022

      Quartz Ignore

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

      1
      +

      Ignoring Notes

      Last updated January 5, 2022

        Quartz Ignore

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

        1
         2
         3
         4
        @@ -33,5 +33,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.


        Interactive Graph

        Made by Jacky Zhao using Quartz, Ā© 2022

        Home +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.


        Interactive Graph

        \ No newline at end of file diff --git a/notes/index.html b/notes/index.html index f373ea159..9ba7b8056 100644 --- a/notes/index.html +++ b/notes/index.html @@ -1,4 +1,4 @@ -Notes

        🪓 Quartz 3

        Search IconIcon to open search

        All Notes

        • Troubleshooting and FAQ

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

          3 minute read. Last updated January 4, 2022

        • Showcase

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

          1 minute read. Last updated January 4, 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!...

          1 minute read. Last updated January 4, 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 January 4, 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 January 4, 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 January 4, 2022

        • Ignoring Notes

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

          1 minute read. Last updated January 4, 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 January 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 January 4, 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 January 4, 2022

        Made by Jacky Zhao using Quartz, Ā© 2022

        Home +While you’re here, join our Discord :)...

        3 minute read. Last updated January 5, 2022

      • Showcase

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

        1 minute read. Last updated January 5, 2022

      • Setup

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

        1 minute read. Last updated January 5, 2022

      • Quartz Philosophy

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

        1 minute read. Last updated January 5, 2022

      • Preview Changes

        If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!...

        1 minute read. Last updated January 5, 2022

      • Obsidian Vault Integration

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

        2 minute read. Last updated January 5, 2022

      • Ignoring Notes

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

        1 minute read. Last updated January 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 January 5, 2022

      • Deploying Quartz to the Web

        GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...

        2 minute read. Last updated January 5, 2022

      • Configuration

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

        2 minute read. Last updated January 5, 2022

      • \ No newline at end of file diff --git a/notes/obsidian/index.html b/notes/obsidian/index.html index b10a17a73..19a88ef17 100644 --- a/notes/obsidian/index.html +++ b/notes/obsidian/index.html @@ -1,4 +1,4 @@ -Obsidian Vault Integration

        🪓 Quartz 3

        Search IconIcon to open search
        -

        Obsidian Vault Integration

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

        Obsidian Vault Integration

        Last updated January 5, 2022

        Setup

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

        New Vault

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

        Linking an existing Vault

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

        Settings

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

        1. Under Options > Files and Links, set the New link format to always be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
        2. Go to Settings > Files & Links > Turn “on” automatically update internal links.
        3. Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)

        Obsidian SettingsObsidian Settings

        Templates

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

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

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


        Interactive Graph

        Made by Jacky Zhao using Quartz, Ā© 2022

        Home +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 be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
        2. Go to Settings > Files & Links > Turn “on” automatically update internal links.
        3. Use [[Wikilinks]] should be off (Wikilinks are not officially supported yet)

        Obsidian SettingsObsidian Settings

        Templates

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

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

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


        Interactive Graph

        \ No newline at end of file diff --git a/notes/philosophy/index.html b/notes/philosophy/index.html index 8403986dc..0192c1774 100644 --- a/notes/philosophy/index.html +++ b/notes/philosophy/index.html @@ -1,4 +1,4 @@ -Quartz Philosophy

        🪓 Quartz 3

        Search IconIcon to open search
        -

        Quartz Philosophy

        Last updated January 4, 2022

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

          Why Quartz?

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

          Quartz Philosophy

          Last updated January 5, 2022

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

            Why Quartz?

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

            I’ve personally found that

            1. It’s nice to access notes from anywhere
            2. 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.


            Interactive Graph

            Made by Jacky Zhao using Quartz, Ā© 2022

            Home +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.


            Interactive Graph

            \ No newline at end of file diff --git a/notes/preview-changes/index.html b/notes/preview-changes/index.html index dde565be7..92cf1d5d9 100644 --- a/notes/preview-changes/index.html +++ b/notes/preview-changes/index.html @@ -1,4 +1,4 @@ -Preview Changes

            🪓 Quartz 3

            Search IconIcon to open search
            -

            Preview Changes

            Last updated January 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!

              Install hugo-obsidian

              This step will generate the list of backlinks for Hugo to parse. Ensure you have +

              Preview Changes

              Last updated January 5, 2022

                If you’d like to preview what your Quartz site looks like before deploying it to the internet, here’s exactly how to do that!

                Install hugo-obsidian

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

                1
                 2
                 3
                @@ -40,5 +40,5 @@ $ cd <location-of-your-local-quartz>
                 $ hugo server
                 
                 # View your site in a browser at http://localhost:1313/
                -

                Interactive Graph


                Interactive Graph

                \ No newline at end of file diff --git a/notes/setup/index.html b/notes/setup/index.html index 2000f4d18..966391802 100644 --- a/notes/setup/index.html +++ b/notes/setup/index.html @@ -1,4 +1,4 @@ -Setup

                🪓 Quartz 3

                Search IconIcon to open search
                -

                Setup

                Last updated January 5, 2022

                Making your own Quartz

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

                Forking

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

                Navigate to the GitHub repository for the Quartz project:

                šŸ“ Quartz Repository

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

                Cloning

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

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

                Editing

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

                āœļø -Editing Notes in Quartz

                Having problems? Checkout our -FAQ and Troubleshooting guide.


                Interactive Graph

                Made by Jacky Zhao using Quartz, Ā© 2022

                Home +Editing Notes in Quartz

                Having problems? Checkout our +FAQ and Troubleshooting guide.


                Interactive Graph

                \ No newline at end of file diff --git a/notes/showcase/index.html b/notes/showcase/index.html index dc30a27da..45d2c31f2 100644 --- a/notes/showcase/index.html +++ b/notes/showcase/index.html @@ -1,5 +1,5 @@ Showcase

                🪓 Quartz 3

                Search IconIcon to open search
                -

                Interactive Graph

                Made by Jacky Zhao using Quartz, Ā© 2022

                Home +

                Interactive Graph

                \ No newline at end of file diff --git a/notes/troubleshooting/index.html b/notes/troubleshooting/index.html index 4d734a4df..6c3253f3a 100644 --- a/notes/troubleshooting/index.html +++ b/notes/troubleshooting/index.html @@ -1,5 +1,5 @@ Troubleshooting and FAQ

                Troubleshooting and FAQ

                Last updated January 5, 2022

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

                  While you’re here, join our Discord :)

                  Some of my pages have ‘January 1, 0001’ as the last modified date

                  This is a problem caused by git treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command.

                  1
                   2
                   3
                  @@ -21,8 +21,8 @@ git config core.ignorecase true
                   # or globally (not recommended)
                   git config --global core.ignorecase true
                   

                  Can I publish only a subset of my pages?

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

                  Can I host this myself and not on GitHub Pages?

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

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

                  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
                   4
                  @@ -35,15 +35,15 @@ git config --global core.ignorecase true
                   # In your current terminal, to reload the session
                   source ~/.bash_profile
                   

                  How come my notes aren’t being rendered?

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

                  My custom domain isn’t working!

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

                  How do I setup Google Analytics?

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

                  How do I change the content on the home page?

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

                  How do I change the colours?

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

                  How do I add images?

                  You can put images anywhere in the /content folder. The only caveat is that you should reference them in your Markdown by prefixing it with a /.

                  1
                  +obsidian to do this for you or you need to manually define it. More details in
                  +the ‘how to edit’ guide.

                  My custom domain isn’t working!

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

                  How do I setup Google Analytics?

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

                  How do I change the content on the home page?

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

                  How do I change the colours?

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

                  How do I add images?

                  You can put images anywhere in the /content folder. 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


                  Interactive Graph

                  Made by Jacky Zhao using Quartz, Ā© 2022

                  Home +Submit an Issue


                  Interactive Graph

                  \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 1b1a1dcaa..8c569dc1d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://quartz.jzhao.xyz/custom-Domain/0https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/hosting/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/editing/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/obsidian/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/preview-changes/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/philosophy/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/setup/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/tags/setup/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/showcase/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/tags/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-01-04T11:39:22-05:00https://quartz.jzhao.xyz/2022-01-04T11:39:22-05:00 \ No newline at end of file +https://quartz.jzhao.xyz/custom-Domain/0https://quartz.jzhao.xyz/categories/https://quartz.jzhao.xyz/notes/config/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/hosting/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/editing/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/ignore-notes/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/obsidian/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/preview-changes/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/philosophy/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/setup/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/tags/setup/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/showcase/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/tags/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/notes/troubleshooting/2022-01-05T19:42:13-05:00https://quartz.jzhao.xyz/2022-01-05T19:42:13-05:00 \ No newline at end of file diff --git a/tags/index.html b/tags/index.html index bd880e352..82922d16e 100644 --- a/tags/index.html +++ b/tags/index.html @@ -1,4 +1,4 @@ -Tags

                  🪓 Quartz 3

                  Search IconIcon to open search
                  -

                  All Tags

                  setup

                  5 notes with this tag (showing first 2 results)

                  • Setup

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

                    1 minute read. Last updated January 4, 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 January 4, 2022

                  Made by Jacky Zhao using Quartz, Ā© 2022

                  Home +

                  All Tags

                  setup

                  5 notes with this tag (showing first 2 results)

                  • Setup

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

                    1 minute read. Last updated January 5, 2022

                  • Obsidian Vault Integration

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

                    2 minute read. Last updated January 5, 2022

                  \ No newline at end of file diff --git a/tags/setup/index.html b/tags/setup/index.html index e72056a09..f63c63cb8 100644 --- a/tags/setup/index.html +++ b/tags/setup/index.html @@ -1,4 +1,4 @@ -setup

                  🪓 Quartz 3

                  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 January 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 January 4, 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 January 4, 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 January 4, 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!...

                    1 minute read. Last updated January 4, 2022

                  Made by Jacky Zhao using Quartz, Ā© 2022

                  Home +

                  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 January 5, 2022

                  • Deploying Quartz to the Web

                    GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go!...

                    2 minute read. Last updated January 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 January 5, 2022

                  • Obsidian Vault Integration

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

                    2 minute read. Last updated January 5, 2022

                  • Setup

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

                    1 minute read. Last updated January 5, 2022

                  \ No newline at end of file