feature docs

content/features/Latex.md

@@ -5,7 +5,7 @@ tags:
 
 Quartz uses [Katex](https://katex.org/) by default to typeset both inline and block math expressions at build time.
 
-## Formatting
+## Syntax
 
 ### Block Math
 

content/features/RSS Feed.md

@@ -0,0 +1,5 @@
+Quartz creates an RSS feed for all the content on your site by generating an `index.xml` file that RSS readers can subscribe to. Because of the RSS spec, this requires the `baseUrl` property in your [[configuration]] to be set properly for RSS readers to pick it up properly.
+
+## Configuration
+
+- Remove RSS feed: set the `enableRSS` field of `Plugin.ContentIndex` in `quartz.config.ts` to be `false`.

content/features/SPA Routing.md

@@ -1 +1,7 @@
-Single-page-app style rendering. This prevents flashes of unstyled content and improves smoothness of Quartz
+Single-page-app style rendering. This prevents flashes of unstyled content and improves the smoothness of Quartz.
+
+Under the hood, this is done by hijacking page navigations and instead fetching the HTML via a `GET` request and then diffing and selectively replacing parts of the page using [micromorph](https://github.com/natemoo-re/micromorph). This allows us to change the content of the page without fully refreshing the page, reducing the amount of content that the browser needs to load.
+
+## Configuration
+
+- Disable SPA Routing: set the `enableSPA` field of the [[configuration]] in `quartz.config.ts` to be `false`.

content/features/backlinks.md

@@ -8,7 +8,7 @@ A backlink for a note is a link from another note to that note. Links in the bac
 
 ## Customization
 
-- Removing backlinks: delete all usages of `Component.Backlinks()` from `quartz.config.ts`.
+- Removing backlinks: delete all usages of `Component.Backlinks()` from `quartz.layout.ts`.
 - Component: `quartz/components/Backlinks.tsx`
 - Style: `quartz/components/styles/backlinks.scss`
 - Script: `quartz/components/scripts/search.inline.ts`

content/features/darkmode.md

@@ -0,0 +1,14 @@
+---
+title: "Darkmode"
+tags:
+  - component
+---
+
+Quartz supports darkmode out of the box that respects the user's theme preference. Any future manual toggles of the darkmode switch will be saved in the browser's local storage so it can be persisted across future page loads.
+
+## Customization
+
+- Removing darkmode: delete all usages of `Component.Darkmode()` from `quartz.layout.ts`.
+- Component: `quartz/components/Darkmode.tsx`
+- Style: `quartz/components/styles/darkmode.scss`
+- Script: `quartz/components/scripts/darkmode.inline.ts`

content/features/full-text search.md

@@ -21,7 +21,7 @@ It properly tokenizes Chinese, Korean, and Japenese characters and constructs se
 
 ## Customization
 
-- Removing search: delete all usages of `Component.Search()` from `quartz.config.ts`.
+- Removing search: delete all usages of `Component.Search()` from `quartz.layout.ts`.
 - Component: `quartz/components/Search.tsx`
 - Style: `quartz/components/styles/search.scss`
 - Script: `quartz/components/scripts/search.inline.ts`

content/features/graph view.md

@@ -22,7 +22,7 @@ Most configuration can be done by passing in options to `Component.Graph()`.
 
 For example, here's what the default configuration looks like:
 
-```typescript title="quartz.config.ts"
+```typescript title="quartz.layout.ts"
 Component.Graph({
   localGraph: {
     drag: true, // whether to allow panning the view around
@@ -53,7 +53,7 @@ When passing in your own options, you can omit any or all of these fields if you
 
 Want to customize it even more?
 
-- Removing graph view: delete all usages of `Component.Graph()` from `quartz.config.ts`.
+- Removing graph view: delete all usages of `Component.Graph()` from `quartz.layout.ts`.
 - Component: `quartz/components/Graph.tsx`
 - Style: `quartz/components/styles/graph.scss`
 - Script: `quartz/components/scripts/graph.inline.ts`

content/features/table of contents.md

@@ -2,4 +2,23 @@
 title: "Table of Contents"
 tags:
   - component
+  - plugins/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.
+
+> [!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`

content/features/upcoming features.md

@@ -4,6 +4,9 @@ draft: true
 
 ## todo
 
+- wikilink to anchors in the same document
+- folders, tags, and content emit overlapping (e.g. for tags/component)
+- 404 using base url
 - nested tags showing duplicate
   - tag page markdown file for description not being rendered
 - back button with anchors / popovers + spa is broken
@@ -13,12 +16,6 @@ draft: true
 - dereference symlink for npx quartz sync
 - test/fix with subpath
 - fix docs with deploy from github
-- write feature docs
-  - rss
-  - spa-routing
-  - table of contents
-  - darkmode
-  - frontmatter parsing
 
 ## high priority backlog
 

content/features/wikilinks.md

@@ -0,0 +1,18 @@
+---
+title: Wikilinks
+---
+
+Wikilinks were pioneered by earlier internet wikis to make it easier to write links across pages without needing to write Markdown or HTML links each time.
+
+Quartz supports Wikilinks by default and these links are resolved by Quartz using `Plugin.CrawlLinks`. See the [Obsidian Help page on Internal Links](https://help.obsidian.md/Linking+notes+and+files/Internal+links) for more information on Wikilink syntax.
+
+This is enabled as a part of [[Obsidian compatibility]] and can be configured and enabled/disabled from that plugin.
+
+## Syntax
+
+- `[[Path to file]]`: produces a link to `Path to file` with the text `Path to file`
+- `[[Path to file | Here's the title override]]`: produces a link to `Path to file` with the text `Here's the title override`
+- `[[Path to file#Anchor]]`: produces a link to the anchor `Anchor` in the file `Path to file`
+
+> [!warning]
+> Currently, Quartz does not support block references or note embed syntax.