This template includes the following npm scripts to aid in development and deployment.
quartz:init
Creating a new repository using Github’s template functionality destroys the template project’s subtree reference to quartz. To work around that issue, this task will re-initialize the quartz subtree. It will:
- remove the project’s
quartz/directory - recreate that directory and its contents as a fresh subtree reference to Quartz’s v4 branch
TODO: notes about re-configin
quartz:update
Updates the quartz subtree reference in the repository.
Note this may result in merge conflicts which will have to be resolved manually.
dev
Start the quartz dev server to watch markdown files for changes. The site will be available at http://localhost:8080.
This script is a shortcut for calling yarn build with the --serve property.
build
Build the static site from the obsidian markdown content.
This script uses a .ts file to call the proper quartz commands to ensure the integration configuration options are respected. See Integration Configuration for details.
build:encrypted
As yarn build but also uses staticrypt to encrypt the output. See Site Encryption for instructions and further information.