quartz.jzhao.xyz Open in urlscan Pro
172.67.171.99  Public Scan

Form analysis
0 forms found in the DOM

Text Content

🪴 QUARTZ 4.0



Search


SearchSearch

Dark modeLight mode


EXPLORER

 *  * Advanced
       * Architecture
       * Creating your own Quartz components
       * Making your own plugins
       * Paths in Quartz
   
    * Feature List
       * Backlinks
       * Breadcrumbs
       * Callouts
       * Darkmode
       * Docker Support
       * Explorer
       * Folder and Tag Listings
       * Full-text Search
       * Graph View
       * Internationalization
       * LaTeX
       * Mermaid Diagrams
       * Obsidian Compatibility
       * OxHugo Compatibility
       * Popover Previews
       * Private Pages
       * Recent Notes
       * RSS Feed
       * SPA Routing
       * Syntax Highlighting
       * Table of Contents
       * Wikilinks
   
    * Plugins
       * AliasRedirects
       * Assets
       * CNAME
       * ComponentResources
       * ContentIndex
       * ContentPage
       * CrawlLinks
       * CreatedModifiedDate
       * Description
       * ExplicitPublish
       * FolderPage
       * Frontmatter
       * GitHubFlavoredMarkdown
       * HardLineBreaks
       * Latex
       * NotFoundPage
       * ObsidianFlavoredMarkdown
       * OxHugoFlavoredMarkdown
       * RemoveDrafts
       * Static
       * SyntaxHighlighting
       * TableOfContents
       * TagPage
   
    * 
    * Authoring Content
    * Building your Quartz
    * Configuration
    * Hosting
    * Layout
    * Migrating from Quartz 3
    * Philosophy of Quartz
    * Quartz Showcase
    * Setting up your GitHub repository
    * Upgrading Quartz

 * 


WELCOME TO QUARTZ 4

May 28, 20242 min read

Quartz is a fast, batteries-included static-site generator that transforms
Markdown content into fully functional websites. Thousands of students,
developers, and teachers are already using Quartz to publish personal notes,
websites, and digital gardens to the web.


🪴 GET STARTED

Quartz requires at least Node v18.14 and npm v9.3.1 to function correctly.
Ensure you have this installed on your machine before continuing.

Then, in your terminal of choice, enter the following commands line by line:

git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create

This will guide you through initializing your Quartz with content. Once you’ve
done so, see how to:

 1. Writing content in Quartz
 2. Configure Quartz’s behaviour
 3. Change Quartz’s layout
 4. Build and preview Quartz
 5. Sync your changes with GitHub
 6. Host Quartz online

If you prefer instructions in a video format you can try following Nicole van
der Hoeven’s video guide on how to set up Quartz!


🔧 FEATURES

 * Obsidian compatibility, full-text search, graph view, note transclusion,
   wikilinks, backlinks, Latex, syntax highlighting, popover previews, Docker
   Support, internationalization and many more right out of the box
 * Hot-reload for both configuration and content
 * Simple JSX layouts and page components
 * Ridiculously fast page loads and tiny bundle sizes
 * Fully-customizable parsing, filtering, and page generation through plugins

For a comprehensive list of features, visit the features page. You can read more
about the why behind these features on the philosophy page and a technical
overview on the architecture page.


🚧 TROUBLESHOOTING + UPDATING

Having trouble with Quartz? Try searching for your issue using the search
feature. If you haven’t already, upgrade to the newest version of Quartz to see
if this fixes your issue.

If you’re still having trouble, feel free to submit an issue if you feel you
found a bug or ask for help in our Discord Community.


GRAPH VIEW

Welcome to Quartz 4Quartz ShowcaseAuthoring ContentConfigurationLayoutBuilding
your QuartzSetting up your GitHub repositoryHostingObsidian
CompatibilityFull-text SearchGraph ViewWikilinksBacklinksLaTeXSyntax
HighlightingPopover PreviewsDocker SupportInternationalizationCreating your own
Quartz componentsSPA RoutingMaking your own pluginsPhilosophy of
QuartzArchitectureUpgrading Quartz



TABLE OF CONTENTS

 * 🪴 Get Started
 * 🔧 Features
 * 🚧 Troubleshooting + Updating


BACKLINKS

 * Authoring Content
 * Building your Quartz
 * Setting up your GitHub repository

--------------------------------------------------------------------------------

Created with Quartz v4.2.3 © 2024

 * GitHub
 * Discord Community