Last Sync: 2025-03-31 13:45:08 (Mobile)

docs/authoring content.md

@@ -0,0 +1,47 @@
+---
+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 initialized. 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.
+- `description`: Description of the page used for link previews.
+- `permalink`: A custom URL for the page that will remain constant even if the path to the file changes.
+- `aliases`: Other names for this note. This is a list of strings.
+- `tags`: Tags for this note.
+- `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.
+
+See [[Frontmatter]] for a complete list of frontmatter.
+
+## Syncing your Content
+
+When your Quartz is at a point you're happy with, you can save your changes to GitHub.
+First, make sure you've [[setting up your GitHub repository|already setup your GitHub repository]] and then do `npx quartz sync`.
+
+## Customization
+
+Frontmatter parsing for `title`, `tags`, `aliases` and `cssclasses` is a functionality of the [[Frontmatter]] plugin, `date` is handled by the [[CreatedModifiedDate]] plugin and `description` by the [[Description]] plugin. See the plugin pages for customization options.

docs/features/table of contents.md

@@ -0,0 +1,18 @@
+---
+title: "Table of Contents"
+tags:
+  - component
+  - feature/transformer
+---
+
+Quartz can automatically generate a table of contents (TOC) from a list of headings on each page. It will also show you your current scrolling position on the page by highlighting headings you've scrolled through with a different color.
+
+You can hide the TOC on a page by adding `enableToc: false` to the frontmatter for that page.
+
+By default, the TOC shows all headings from H1 (`# Title`) to H3 (`### Title`) and is only displayed if there is more than one heading on the page.
+
+## Customization
+
+The table of contents is a functionality of the [[TableOfContents]] plugin. See the plugin page for more customization options.
+
+It also needs the `TableOfContents` component, which is displayed in the right sidebar by default. You can change this by customizing the [[layout]]. The TOC component can be configured with the `layout` parameter, which can either be `modern` (default) or `legacy`.

quartz/components/Footer.tsx

@@ -24,7 +24,6 @@ export default ((opts?: Options) => {
             </li>
           ))}
         </ul>
-        <script defer src="https://enneaumami.netlify.app/script.js" data-website-id="ee01f4e4-959a-45e1-a527-d2f261304075"></script>
       </footer>
     )
   }

quartz/plugins/emitters/contentIndex.tsx

@@ -25,17 +25,17 @@ interface Options {
   enableSiteMap: boolean
   enableRSS: boolean
   rssLimit?: number
-  rssFullHtml: boolean 
+  rssFullHtml: boolean
   rssSlug: string
   includeEmptyFiles: boolean
 }
 
 const defaultOptions: Options = {
   enableSiteMap: true,
-  enableRSS: true, 
+  enableRSS: true,
-  rssLimit: 10, 
+  rssLimit: 10,
-  rssFullHtml: true, 
+  rssFullHtml: false,
-  rssSlug: "feed", 
+  rssSlug: "index",
   includeEmptyFiles: true,
 }
 

quartz/static/font/font-style.css

@@ -1,9 +0,0 @@
-/*! Generated by Font Squirrel (https://www.fontsquirrel.com) on April 4, 2019 */
-
-@font-face {
-  font-family: "biro_script_standardRgus";
-  src:
-    url("biro_script_standard_us.ttf") format("woff");
-  font-weight: normal;
-  font-style: normal;
-}