A collection of Obsidian themes adapted for Quartz.
Install the core plugin and your chosen theme:
npm install @quartz-themes/core @quartz-themes/<THEME-NAME>Then add the plugin to your quartz.config.yaml:
plugins:
- source: "@quartz-themes/core"
options:
theme: "<THEME-NAME>"
mode: "both"Tip
Example for Tokyo Night:
npm install @quartz-themes/core @quartz-themes/tokyo-nightplugins:
- source: "@quartz-themes/core"
options:
theme: "tokyo-night"
mode: "both"Tip
For themes with variants (e.g. Catppuccin), specify the variation:
npm install @quartz-themes/core @quartz-themes/catppuccinplugins:
- source: "@quartz-themes/core"
options:
theme: "catppuccin"
variation: "frappe"
mode: "both"Important
For dark-only or light-only themes, set mode to "dark" or "light" instead of "both".
Note
This method is for Quartz v4 or users who prefer not to use npm packages.
Add the following lines to your deploy.yml before the permissions section:
env:
THEME_NAME: <THEME-NAME>And add the following lines to your deploy.yml before the build step:
- name: Fetch Quartz Theme
run: curl -s -S https://raw.githubusercontent.com/saberzero1/quartz-themes/master/action.sh | bash -s -- $THEME_NAMEImportant
Replace <THEME-NAME> with your desired theme name. See Compatibility List
Note
This method is for Quartz v4 or users who prefer not to use npm packages.
Manually download the _index.scss file from the themes directory of your choice in this repository, and place it in your Quartz repository's at quartz/styles/themes/_index.scss. (Create the themes directory if it doesn't exist.)
Then, add the following line to your src/styles/custom.scss file after the @use "base"; line:
@use "themes";Important
For dark-only or light-only themes, remember to remove Component.Darkmode() from your quartz.config.ts file.
Glossary
| Status | Description |
|---|---|
| Fully supported | |
| Partially supported (see theme page for details) | |
| This theme contains information for the Style Settings plugin. See the table for the configured sub-themes. | |
| Testing compatibility | |
| Waiting for upstream fixes | |
| Not started | |
| Won't support | |
| Broken or removed from Obsidian |
| Theme Modes | Description |
|---|---|
| Both dark and light theme | |
| Light theme only | |
| Dark theme only |
Quartz Themes is licensed under the MIT License.
The themes themselves are licensed under the same license as the respective Obsidian theme, which can be found in the individual theme directories. This is to ensure that the themes remain compatible with their original licenses and to respect the work of the original theme authors, while allowing users to use them in their Quartz repositories.
An overview of the licenses per theme can be found in the compatibility table above. Please refer to the original theme repositories for more extensive information on their licenses.
