more docs + link fixing

.github/workflows/deploy.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.79.1'
+          hugo-version: '0.82.0'
           extended: true
 
       - name: Build

content/moc/directory.md

@@ -2,15 +2,16 @@
 title: "Quartz Documentation"
 ---
 
+## Setup
 Welcome to Quartz! Whether you're setting up a website and project for the first time or a seasoned digital gardener, I hope that you'll find something useful about this project.
 
 Let's get to business and get you started!
 
-## Setup
-📚 [setup](notes/setup.md)
-
-## Configuration
-[config](notes/config.md)
+- 📚 [Setup your own digital garden using Quartz](notes/setup.md)
+- 🔗 [Linking with an Obsidian Vault](notes/obsidian.md)
+- 🎨 [Customizing and Styling Quartz](notes/config.md)
+- 🌍 [Hosting Quartz online!](notes/hosting.md)
 
 ## Troubleshooting
-[troubleshooting](notes/troubleshooting.md)
+- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
+- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)

content/notes/config.md

@@ -1,3 +1,8 @@
 ---
 title: "Configuration"
 ---
+
+## Styling
+## Layouts
+### Home Page
+### Partials

content/notes/editing.md

@@ -0,0 +1,66 @@
+---
+title: "Editing Content in Quartz"
+---
+
+## Editing 
+Quartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
+
+**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 create a link, 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**. 
+
+```markdown
+For example, I want to link this current document to `config.md`.
+[A link to the config page](config.md)
+```
+
+### Obsidian
+I *strongly* 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 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, I'm not going to stop you!
+
+## 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. For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
+
+###  Installing Hugo
+Hugo is the static site generator that powers Quartz. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/).
+
+```
+# Navigate to your local Quartz folder
+$ cd <location-of-your-local-quartz>
+
+# Start local server
+$ hugo server
+
+# View your site in a browser at http://localhost:1313/
+```
+
+### Install `hugo-obsidian`
+This step is **doubly optional** and only applies to those who want to see their Interactive Graph and backlinks locally while previewing changes on the site. 
+
+Ensure you have Go (>= 1.16) installed.
+
+```shell
+# Clone the Repository
+$ git clone https://github.com/jackyzha0/hugo-obsidian.git
+
+# Install and link `hugo-obsidian` locally
+$ go install .
+
+# Navigate to your local Quartz folder
+$ cd <location-of-your-local-quartz>
+
+# Scrape all links in your Quartz folder and generate info for Quartz
+$ hugo-obsidian -input=content -output=data
+```
+
+Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
+
+## 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!](notes/hosting.md)
+
+Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

content/notes/hosting.md

@@ -2,8 +2,13 @@
 title: "Deploying to GitHub Pages"
 ---
 
+## GitHub Pages
+
+## Custom subdomain
 Change `baseURL` in `/config.toml`
 
 ```toml
 baseURL = "https://quartz.jzhao.xyz/"
 ```
+
+Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

content/notes/obsidian.md

@@ -1,3 +1,12 @@
 ---
 title: "Obsidian Vault Integration"
 ---
+
+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 
+
+## Linking an existing Vault
+
+![](/notes/images/obsidian-settings.png)

content/notes/setup.md

@@ -2,7 +2,28 @@
 title: "Setup"
 ---
 
-![](/notes/images/obsidian-settings.png)
+## Making your own Quartz
+Setting 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!
 
+### Forking
+> A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
 
-Having problems? [troubleshooting](notes/troubleshooting.md)
+Navigate to the GitHub repository for the Quartz project:
+
+📁 [Quartz Repository](https://github.com/jackyzha0/quartz)
+
+Then, 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).
+
+### 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.
+
+```shell
+$ 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](notes/editing.md)
+
+Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

content/notes/troubleshooting.md

@@ -1,3 +1,3 @@
 ---
-title: "troubleshooting"
+title: "Troubleshooting and FAQ"
 ---

layouts/_default/_markup/render-link.html

@@ -1,2 +1,7 @@
 {{$trimmed := strings.TrimSuffix ".md" (.Destination | safeURL)}}
-<a href="{{ if (hasPrefix $trimmed "/") }}{{ $trimmed }}{{ else }}{{ print "/" $trimmed }}{{ end }}" rel="noopener">{{ .Text | safeHTML }}</a>
+{{$external := strings.HasPrefix $trimmed "http" }}
+{{ if $external }}
+<a href="{{ $trimmed }}" rel="noopener">{{ .Text | safeHTML }}</a>
+{{else}}
+<a href="{{ if (hasPrefix $trimmed "/") }}{{ $trimmed }}{{ else }}{{ print "/" $trimmed }}{{ end }}" rel="noopener">{{ .Text | safeHTML }}</a>
+{{end}}

layouts/partials/head.html

@@ -1,8 +1,4 @@
 <head>
-    <link rel="preconnect" href="https://www.googletagmanager.com">
-    <link crossorigin rel="preconnect" href="https://www.google-analytics.com">
-    {{ template "_internal/google_analytics.html" . }}
-
     <!-- Meta tags -->
     <meta charset="UTF-8">
     <meta name="description" content="{{$.Site.Data.config.description}}">
@@ -21,4 +17,5 @@
     </style>
     {{end}}
     {{end}}
-</head>
+</head>
+{{ template "_internal/google_analytics.html" . }}