run prettier

Author: jackyzha0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Something about Quartz isn't working the way you expect
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea or improvement for Quartz
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: Build and Test 
+name: Build and Test
 
 on:
   push:
@@ -34,4 +34,4 @@ jobs:
         run: npm test
 
       - name: Ensure Quartz builds
-        run: npx quartz build 
+        run: npx quartz build

CODE_OF_CONDUCT.md

@@ -20,28 +20,28 @@ If you see someone who is making an extra effort to ensure our community is welc
 
 The following behaviors are expected and requested of all community members:
 
- * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
- * Exercise consideration and respect in your speech and actions.
- * Attempt collaboration before conflict.
- * Refrain from demeaning, discriminatory, or harassing behavior and speech.
- * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
- * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+- Exercise consideration and respect in your speech and actions.
+- Attempt collaboration before conflict.
+- Refrain from demeaning, discriminatory, or harassing behavior and speech.
+- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
 
 ## 4. Unacceptable Behavior
 
 The following behaviors are considered harassment and are unacceptable within our community:
 
- * Violence, threats of violence or violent language directed against another person.
- * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
- * Posting or displaying sexually explicit or violent material.
- * Posting or threatening to post other people's personally identifying information ("doxing").
- * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
- * Inappropriate photography or recording.
- * Inappropriate physical contact. You should have someone's consent before touching them.
- * Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
- * Deliberate intimidation, stalking or following (online or in person).
- * Advocating for, or encouraging, any of the above behavior.
- * Sustained disruption of community events, including talks and presentations.
+- Violence, threats of violence or violent language directed against another person.
+- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+- Posting or displaying sexually explicit or violent material.
+- Posting or threatening to post other people's personally identifying information ("doxing").
+- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+- Inappropriate photography or recording.
+- Inappropriate physical contact. You should have someone's consent before touching them.
+- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+- Deliberate intimidation, stalking or following (online or in person).
+- Advocating for, or encouraging, any of the above behavior.
+- Sustained disruption of community events, including talks and presentations.
 
 ## 5. Weapons Policy
 
@@ -59,14 +59,11 @@ If a community member engages in unacceptable behavior, the community organizers
 
 If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected].
 
-
-
 Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
 
 ## 8. Addressing Grievances
 
-If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify @jackyzha0 with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. 
-
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify @jackyzha0 with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
 
 ## 9. Scope
 
@@ -80,7 +77,7 @@ [email protected]
 
 ## 11. License and attribution
 
-The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). 
+The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
 
 Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
 

content/advanced/creating components.md

@@ -2,4 +2,4 @@
 title: Creating your own Quartz components
 ---
 
-See the [component listing](/tags/component) for a full-list of the Quartz built-in components.
+See the [component listing](/tags/component) for a full-list of the Quartz built-in components.

content/advanced/making plugins.md

@@ -5,6 +5,7 @@ title: Making your own plugins
 This part of the documentation will assume you have some basic coding knowledge and will include code snippets that describe the interface of what Quartz plugins should look like.
 
 ## Transformers
+
 ```ts
 export type QuartzTransformerPluginInstance = {
   name: string
@@ -17,4 +18,4 @@ export type QuartzTransformerPluginInstance = {
 
 ## Filters
 
-## Emitters
+## Emitters

content/configuration.md

@@ -2,7 +2,7 @@
 title: Configuration
 ---
 
-Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts`. 
+Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts`.
 
 If you edit this file using a text-editor that has TypeScript language support like VSCode, it will warn you when you you've made an error in your configuration.
 
@@ -16,33 +16,35 @@ const config: QuartzConfig = {
 ```
 
 ## General Configuration
+
 This part of the configuration concerns anything that can affect the whole site. The following is a list breaking down all the things you can configure:
 
 - `pageTitle`: used as an anchor to return to the home page. This is also used when generating the [[RSS Feed]] for your site.
 - `enableSPA`: whether to enable [[SPA Routing]] on your site.
 - `enablePopovers`: whether to enable [[popover previews]] on your site.
-- `analytics`: what to use for analytics on your site. Values can be 
-	- `null`: don't use analytics;
-	- `{ provider: 'plausible' }`: use [Plausible](https://plausible.io/), a privacy-friendly alternative to Google Analytics; or
-	- `{ provider: 'google', tagId: <your-google-tag> }`: use Google Analytics
-- `caononicalUrl`: sometimes called `baseURL` in other site generators. This is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `https://quartz.jzhao.xyz/` for this site). Note that Quartz 4 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter *where* you end up actually deploying it.
-- `ignorePatterns`: a list of [glob](https://en.wikipedia.org/wiki/Glob_(programming)) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder.
+- `analytics`: what to use for analytics on your site. Values can be
+  - `null`: don't use analytics;
+  - `{ provider: 'plausible' }`: use [Plausible](https://plausible.io/), a privacy-friendly alternative to Google Analytics; or
+  - `{ provider: 'google', tagId: <your-google-tag> }`: use Google Analytics
+- `caononicalUrl`: sometimes called `baseURL` in other site generators. This is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `https://quartz.jzhao.xyz/` for this site). Note that Quartz 4 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter _where_ you end up actually deploying it.
+- `ignorePatterns`: a list of [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder.
 - `theme`: configure how the site looks.
-	- `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here.
-		- `header`: Font to use for headers
-		- `code`: Font for inline and block quotes.
-		- `body`: Font for everything
-	- `colors`: controls the theming of the site. 
-		- `light`: page background
-		- `lightgray`: borders
-		- `gray`: graph links, heavier borders
-		- `darkgray`: body text
-		- `dark`: header text and icons
-		- `secondary`: link colour, current [[graph view|graph]] node
-		- `tertiary`: hover states and visited [[graph view|graph]] nodes
-		- `highlight`: internal link background, highlighted text, [[syntax highlighting|highlighted lines of code]]
+  - `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here.
+    - `header`: Font to use for headers
+    - `code`: Font for inline and block quotes.
+    - `body`: Font for everything
+  - `colors`: controls the theming of the site.
+    - `light`: page background
+    - `lightgray`: borders
+    - `gray`: graph links, heavier borders
+    - `darkgray`: body text
+    - `dark`: header text and icons
+    - `secondary`: link colour, current [[graph view|graph]] node
+    - `tertiary`: hover states and visited [[graph view|graph]] nodes
+    - `highlight`: internal link background, highlighted text, [[syntax highlighting|highlighted lines of code]]
 
 ## Plugins
+
 You can think of Quartz plugins as a series of transformations over content.
 
 ![[quartz-transform-pipeline.png]]
@@ -62,18 +64,19 @@ plugins: {
 By adding, removing, and reordering plugins from the `tranformers`, `filters`, and `emitters` fields, you can customize the behaviour of Quartz.
 
 > [!note]
-> Each node is modified by every transformer *in order*. Some transformers are position-sensitive so you may need to take special note of whether it needs come before or after any other particular plugins. 
+> Each node is modified by every transformer _in order_. Some transformers are position-sensitive so you may need to take special note of whether it needs come before or after any other particular plugins.
 
 Additionally, plugins may also have their own configuration settings that you can pass in. For example, the [[Latex]] plugin allows you to pass in a field specifying the `renderEngine` to choose between Katex and MathJax.
 
 ```ts
 transformers: [
-	Plugin.FrontMatter(),                   // uses default options
-	Plugin.Latex({ renderEngine: 'katex' }) // specify some options
+  Plugin.FrontMatter(), // uses default options
+  Plugin.Latex({ renderEngine: "katex" }), // specify some options
 ]
 ```
 
 ### Layout
-Certain emitters may also output [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) files. To make sure that 
+
+Certain emitters may also output [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) files. To make sure that
 
 ### Components

content/features/Latex.md

@@ -3,6 +3,7 @@ Quartz uses [Katex](https://katex.org/) by default to typeset both inline and bl
 ## Formatting
 
 ### Block Math
+
 Block math can be rendered by delimiting math expression with `$$`.
 
 ```
@@ -20,20 +21,25 @@ f(x) = \int_{-\infty}^\infty
 $$
 
 ### Inline Math
+
 Similarly, inline math can be rendered by delimiting math expression with a single `$`. For example, `$e^{i\pi} = -1$` produces $e^{i\pi} = -1$
 
 ### Escaping symbols
-There will be cases where you may have more than one `$` in a paragraph at once which may accidentally trigger MathJax/Katex. 
+
+There will be cases where you may have more than one `$` in a paragraph at once which may accidentally trigger MathJax/Katex.
 
 To get around this, you can escape the dollar sign by doing `\$` instead.
 
 For example:
+
 - Incorrect: `I have $1 and you have $2` produces I have $1 and you have $2
 - Correct: `I have \$1 and you have \$2` produces I have \$1 and you have \$2
 
 ## MathJax
+
 In `quartz.config.ts`, you can configure Quartz to use [MathJax SVG rendering](https://docs.mathjax.org/en/latest/output/svg.html) by replacing `Plugin.Latex({ renderEngine: 'katex' })` with `Plugin.Latex({ renderEngine: 'mathjax' })`
 
 ## Customization
+
 - Removing Latex support: remove all instances of `Plugin.Latex()` from `quartz.config.ts`.
-- Plugin: `quartz/plugins/transformers/latex.ts`
+- Plugin: `quartz/plugins/transformers/latex.ts`

content/features/Mermaid diagrams.md

@@ -1,5 +1,5 @@
 > [!warning]
-> Wondering why Mermaid diagrams may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is *after* `Plugin.SyntaxHighlighting()`.
+> Wondering why Mermaid diagrams may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is _after_ `Plugin.SyntaxHighlighting()`.
 
 ```mermaid
 sequenceDiagram

content/features/SPA Routing.md

@@ -1 +1 @@
-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 smoothness of Quartz

content/features/backlinks.md

@@ -1,13 +1,14 @@
 ---
 title: Backlinks
 tags:
-- component
+  - component
 ---
 
 A backlink for a note is a link from another note to that note. Links in the backlink pane also feature rich [[popover previews]] if you have that feature enabled.
 
 ## Customization
+
 - Removing backlinks: delete all usages of `Component.Backlinks()` from `quartz.config.ts`.
 - Component: `quartz/components/Backlinks.tsx`
 - Style: `quartz/components/styles/backlinks.scss`
-- Script: `quartz/components/scripts/search.inline.ts`
+- Script: `quartz/components/scripts/search.inline.ts`

content/features/callouts.md

@@ -3,15 +3,16 @@ title: Callouts
 ---
 
 > [!warning]
-> Wondering why callouts may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is *after* `Plugin.SyntaxHighlighting()`.
-
+> Wondering why callouts may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is _after_ `Plugin.SyntaxHighlighting()`.
 
 > [!info]
 > Default title
 
 > [!question]+ Can callouts be nested?
+>
 > > [!todo]- Yes!, they can.
-> > > [!example]  You can even use multiple layers of nesting.
+> >
+> > > [!example] You can even use multiple layers of nesting.
 
 > [!EXAMPLE] Examples
 >
@@ -21,31 +22,31 @@ title: Callouts
 >
 > Aliases: note
 
-> [!abstract] Summaries 
+> [!abstract] Summaries
 >
 > Aliases: abstract, summary, tldr
 
-> [!info] Info 
+> [!info] Info
 >
 > Aliases: info, todo
 
-> [!tip] Hint 
+> [!tip] Hint
 >
 > Aliases: tip, hint, important
 
-> [!success] Success 
+> [!success] Success
 >
 > Aliases: success, check, done
 
-> [!question] Question 
+> [!question] Question
 >
 > Aliases: question, help, faq
 
-> [!warning] Warning 
+> [!warning] Warning
 >
 > Aliases: warning, caution, attention
 
-> [!failure] Failure 
+> [!failure] Failure
 >
 > Aliases: failure, fail, missing
 

content/features/full-text search.md

@@ -1,26 +1,28 @@
 ---
 title: Full-text Search
-tags: 
-- component
+tags:
+  - component
 ---
 
 Full-text search in Quartz is powered by [Flexsearch](https://github.com/nextapps-de/flexsearch). It's fast enough to return search results in under 10ms for Quartzs as large as half a million words.
 
-It can be opened by either clicking on the search bar or pressing ⌘+K. The top 5 search results are shown on each query. Matching subterms are highlighted and the most relevant 30 words are excerpted. Clicking on a search result will navigate to that page. 
+It can be opened by either clicking on the search bar or pressing ⌘+K. The top 5 search results are shown on each query. Matching subterms are highlighted and the most relevant 30 words are excerpted. Clicking on a search result will navigate to that page.
 
 This component is also keyboard accessible: Tab and Shift+Tab will cycle forward and backward through search results and Enter will navigate to the highlighted result (first result by default).
 
 > [!info]
 > Search requires the `ContentIndex` emitter plugin to be present in the [[configuration]].
 
 ### Indexing Behaviour
+
 By default, it indexes every page on the site with **Markdown syntax removed**. This means link URLs for instance are not indexed.
 
 It properly tokenizes Chinese, Korean, and Japenese characters and constructs separate indexes for the title and content, weighing title matches above content matches.
 
 ## Customization
+
 - Removing search: delete all usages of `Component.Search()` from `quartz.config.ts`.
 - Component: `quartz/components/Search.tsx`
 - Style: `quartz/components/styles/search.scss`
 - Script: `quartz/components/scripts/search.inline.ts`
-	- You can edit `contextWindowWords` or `numSearchResults` to suit your needs
+  - You can edit `contextWindowWords` or `numSearchResults` to suit your needs