Quartz Installation Instructions

Instructions to install quartz locally.

---

Installation Instructions

1. Clone the Repository

git clone https://github.com/jackyzha0/quartz.git <target-directory>
cd <target-directory>

2. Install the Dependencies

npm install

3. Run Interactive Initialization

npx quartz create

It will ask for a starting template, here you can choose from:

1. Default: a clean quartz setup with sensible defaults, such as search, explorer, etc.
2. Obsidian: it mimics obsidian app visuals.
3. TTRPG: is a layout optimized for RPG games.
4. Blog: Removes wiki style functionality to have a cleaner blog layout

It will ask how to initialize the content:

1. Empty Quartz: no default content.
2. Copy an existing folder: will copy a content folder.
3. Symlink an existing folder: will symlink the content of an existing folder.

It will ask how quartz should resolve links:

1. Shortest paths.
2. Absolute paths.
3. Relative paths.

It will ask the base URL for your site.

4. Check the Installation

The following command will spawn a development server on http://localhost:8080.

npx quartz build --serve

5. Set Your Git Remote

Rename current origin to be upstream:

git remote rename origin vendor

Add your actual remote as origin:

git remote add origin <remote-repository-url>

Commit initialization changes:

git add "."
git commit -m "chore: initialized quartz"

Remember to take note of the current branch name, you’ll need it for updating Quartz.

Push the current branch to your remote:

git branch -m main
git push -u origin main