mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-24 23:15:46 -05:00
Pull-Request [ariasae-10-2-2023] from Obsidian (#18)
* PUSH NOTE : Chuckwalla.md * PUSH NOTE : Grammar.md * PUSH NOTE : Callouts.md * DELETE FILE : content/Bookmarklets.md * DELETE FILE : content/Chuckwalla.md * DELETE FILE : content/Explore the Garden.md * DELETE FILE : content/Guide.md * DELETE FILE : docs/authoring content.md * DELETE FILE : docs/features/table of contents.md
This commit is contained in:
parent
21c31da8c8
commit
c6c381e39c
File diff suppressed because one or more lines are too long
@ -4,7 +4,8 @@ tags:
|
||||
- reference
|
||||
- obsidian
|
||||
compartir: true
|
||||
lastmod: 2023-09-18
|
||||
lastmod: 2023-10-02
|
||||
categories: Obsidian
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Explore the Garden
|
||||
description: Want to explore the garden but don't know where to start? You came to the right place.
|
||||
summary: Want to explore the garden but don't know where to start? You came to the right place.
|
||||
tags:
|
||||
- meta
|
||||
lastmod: 2023-09-29
|
||||
compartir: true
|
||||
---
|
||||
|
||||
|
||||
Feeling lost around the site? No worries, here's a list of pages you can visit:
|
||||
|
||||
* [[Public Journal]]
|
||||
* [[Free Facts]]
|
||||
* [[Poetry]]
|
||||
* [[Callouts]]
|
||||
* [[Markdown Demo]]
|
||||
* [[Mermaid JS Graphs]]
|
||||
* [[Tools]]
|
||||
* [[Projects Overview|Projects]]
|
||||
* [[The Moon (Earth)]]
|
||||
|
||||
Have a wonderful time!
|
||||
@ -1,9 +1,10 @@
|
||||
---
|
||||
title: Grammar
|
||||
compartir: true
|
||||
lastmod: 2023-09-18
|
||||
lastmod: 2023-10-02
|
||||
enableToc: true
|
||||
tags: learning
|
||||
tags:
|
||||
- learning
|
||||
---
|
||||
|
||||
## Singular Pluralities
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Garden Exploration Guide
|
||||
description: Want to explore the garden but don't know where to start? You came to the right place.
|
||||
summary: Want to explore the garden but don't know where to start? You came to the right place.
|
||||
tags:
|
||||
- meta
|
||||
lastmod: 2023-09-28
|
||||
compartir: true
|
||||
---
|
||||
|
||||
|
||||
Feeling lost around the site? No worries, here's a list of pages you can visit:
|
||||
|
||||
* [[Public Journal]]
|
||||
* [[Free Facts]]
|
||||
* [[Poetry]]
|
||||
* [[Callouts]]
|
||||
* [[Markdown Demo]]
|
||||
* [[Mermaid JS Graphs]]
|
||||
* [[Tools]]
|
||||
* [[Projects Overview|Projects]]
|
||||
* [[The Moon (Earth)]]
|
||||
|
||||
Have a wonderful time!
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Chuckwalla
|
||||
lastmod: 2023-09-21
|
||||
lastmod: 2023-10-02
|
||||
compartir: true
|
||||
category: Pets
|
||||
---
|
||||
Chuckwallas are lizards found primarily in arid regions of the southwestern United States and northern Mexico. Some are found on coastal islands. The five species of chuckwallas are all placed within the genus _Sauromalus_; they are part of the iguanid family, _Iguanidae_—composed of iguanas, chuckwallas, and their prehistoric relatives.
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
title: Authoring Content
|
||||
---
|
||||
|
||||
All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initailized. Any Markdown in this folder will get processed by Quartz.
|
||||
|
||||
It is recommended that you use [Obsidian](https://obsidian.md/) as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments.
|
||||
|
||||
Got everything setup? Let's [[build]] and preview your Quartz locally!
|
||||
|
||||
## Syntax
|
||||
|
||||
As Quartz uses Markdown files as the main way of writing content, it fully supports Markdown syntax. By default, Quartz also ships with a few syntax extensions like [Github Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (footnotes, strikethrough, tables, tasklists) and [Obsidian Flavored Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown) ([[callouts]], [[wikilinks]]).
|
||||
|
||||
Additionally, Quartz also allows you to specify additional metadata in your notes called **frontmatter**.
|
||||
|
||||
```md title="content/note.md"
|
||||
---
|
||||
title: Example Title
|
||||
draft: false
|
||||
tags:
|
||||
- example-tag
|
||||
---
|
||||
|
||||
The rest of your content lives here. You can use **Markdown** here :)
|
||||
```
|
||||
|
||||
Some common frontmatter fields that are natively supported by Quartz:
|
||||
|
||||
- `title`: Title of the page. If it isn't provided, Quartz will use the name of the file as the title.
|
||||
- `aliases`: Other names for this note. This is a list of strings.
|
||||
- `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz.
|
||||
- `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format.
|
||||
|
||||
## Syncing your Content
|
||||
|
||||
When your Quartz is at a point you're happy with, you can save your changes to GitHub by doing `npx quartz sync`.
|
||||
|
||||
> [!hint] Flags and options
|
||||
> For full help options, you can run `npx quartz sync --help`.
|
||||
>
|
||||
> Most of these have sensible defaults but you can override them if you have a custom setup:
|
||||
>
|
||||
> - `-d` or `--directory`: the content folder. This is normally just `content`
|
||||
> - `-v` or `--verbose`: print out extra logging information
|
||||
> - `--commit` or `--no-commit`: whether to make a `git` commit for your changes
|
||||
> - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz
|
||||
> - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: "Table of Contents"
|
||||
tags:
|
||||
- component
|
||||
- plugin/transformer
|
||||
---
|
||||
|
||||
Quartz can automatically generate a table of contents from a list of headings on each page. It will also show you your current scroll position on the site by marking headings you've scrolled through with a different colour.
|
||||
|
||||
By default, it will show all headers from H1 (`# Title`) all the way to H3 (`### Title`) and will only show the table of contents if there is more than 1 header on the page.
|
||||
You can also hide the table of contents on a page by adding `showToc: false` to the frontmatter for that page.
|
||||
|
||||
> [!info]
|
||||
> This feature requires both `Plugin.TableOfContents` in your `quartz.config.ts` and `Component.TableOfContents` in your `quartz.layout.ts` to function correctly.
|
||||
|
||||
## Customization
|
||||
|
||||
- Removing table of contents: remove all instances of `Plugin.TableOfContents()` from `quartz.config.ts`. and `Component.TableOfContents()` from `quartz.layout.ts`
|
||||
- Changing the max depth: pass in a parameter to `Plugin.TableOfContents({ maxDepth: 4 })`
|
||||
- Changing the minimum number of entries in the Table of Contents before it renders: pass in a parameter to `Plugin.TableOfContents({ minEntries: 3 })`
|
||||
- Component: `quartz/components/TableOfContents.tsx`
|
||||
- Style:
|
||||
- Modern (default): `quartz/components/styles/toc.scss`
|
||||
- Legacy Quartz 3 style: `quartz/components/styles/legacyToc.scss`
|
||||
- Script: `quartz/components/scripts/toc.inline.ts`
|
||||
Loading…
Reference in New Issue
Block a user