alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2025-05-25 09:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

more desc

Browse source
This commit is contained in:
jackyzha0 2021-07-19 00:36:15 -04:00
parent b841471613
commit c0ee39a937
6 changed files with 70 additions and 43 deletions
content/notes
editing.md

59
content/notes/editing.md
View file

@ -5,11 +5,21 @@ 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/).
### 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!
### 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`.**
**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, 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**.
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**.
```markdown
For example, I want to link this current document to `config.md`.
@ -24,20 +34,28 @@ Hugo is picky when it comes to metadata for files. Ensure that you have a title
title: "Example Title"
---
## Headers should start at H2
Rest of your content here...
```
### 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.
### Install `hugo-obsidian`
This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed.
```shell
# Install and link `hugo-obsidian` locally
$ go install github.com/jackyzha0/hugo-obsidian
# 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!
### 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/).
@ -51,27 +69,6 @@ $ 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!