docs: updated plugin documentation to match recent changes

This commit is contained in:
saberzero1
2026-03-16 13:15:55 +01:00
parent 6ec256dcbc
commit 14328062da
4 changed files with 11 additions and 6 deletions

View File

@@ -18,7 +18,7 @@ The `create` command initializes a new Quartz project. It helps you set up your
## Templates
When you run `quartz create`, you can choose a configuration template that pre-configures Quartz for your use case:
When you run `quartz create`, you can choose a configuration template that pre-configures Quartz for your use case. The selected template always overwrites `quartz.config.yaml`, even if one already exists. After applying the template, Quartz automatically runs plugin resolution to install any plugins the template requires and remove any that are no longer referenced.
- **Default**: A clean Quartz setup with sensible defaults. Best for starting from scratch.
- **Obsidian**: Optimized for Obsidian vaults with full Obsidian Flavored Markdown support (wikilinks, callouts, mermaid diagrams, etc.). Automatically sets link resolution to `shortest` and skips the link resolution prompt.
@@ -61,7 +61,7 @@ If you run `npx quartz create` without any arguments, it will guide you through
2. **Select a strategy**: Choose between `new`, `copy`, or `symlink`.
3. **Enter base URL**: Provide the URL where your site will be hosted.
4. **Select link resolution**: Choose how your links are formatted (skipped for Obsidian and TTRPG templates).
5. **Finish**: Quartz will set up the directory structure and create your configuration.
5. **Finish**: Quartz will set up the directory structure, create your configuration, and automatically install any plugins referenced in the template.
## Example: Importing an Obsidian Vault