zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: cleanup

Browse Source
This commit is contained in:
saberzero1
2026-03-31 19:39:50 +02:00
parent 8e7100a562
commit 84ee01f790
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/cli/index.md
View File

@@ -13,7 +13,7 @@ You can run the CLI using `npx quartz`.
| `create` | Initialize a new Quartz project with template selection | `npx quartz create` |
| `build` | Generate static HTML files | `npx quartz build` |
| `sync` | Sync content with GitHub | `npx quartz sync` |
| `upgrade` | Upgrade Quartz to the latest version | `npx quartz upgrade` |
| `upgrade` | Upgrade Quartz to the latest version (alias: `update`) | `npx quartz upgrade` |
| `plugin` | Manage Quartz plugins (install, add, remove, etc.) | `npx quartz plugin list` |
| `tui` | Launch the interactive plugin manager | `npx quartz tui` |
@@ -22,7 +22,7 @@ You can run the CLI using `npx quartz`.
- [[cli/create|create]]: Initialize a new Quartz project with a choice of templates (default, obsidian, ttrpg, blog) and base URL configuration.
- [[cli/build|build]]: Build your Quartz site into static HTML. Includes a development server.
- [[cli/sync|sync]]: Push and pull changes between your local machine and GitHub.
- [[cli/upgrade|upgrade]]: Upgrade the Quartz framework to the latest version.
- [[cli/upgrade|upgrade]]: Upgrade the Quartz framework to the latest version. Also available as `npx quartz update`.
- [[cli/restore|restore]]: Recover your content folder from the local cache.
- [[cli/migrate|migrate]]: Convert older configuration files to the new YAML format.
- [[cli/plugin|plugin]]: Install, add, remove, prune, and configure plugins. Use `plugin install` with flags for lockfile/config sync, updates, and checks.

6
docs/cli/plugin.md
View File

@@ -238,10 +238,12 @@ See [[configuration#Advanced Source Options|Advanced Source Options]] for the fu
The old commands still work as hidden aliases but will print a deprecation warning.
## Interactive Mode
## Plugin Status
Running the plugin command without any subcommand will launch the [[cli/tui|TUI]], which provides a visual interface for all these operations.
Running the plugin command without any subcommand shows a status dashboard of all installed plugins, including whether updates are available:
```shell
npx quartz plugin
```
This displays each plugin with its source, commit, enabled/disabled status, and checks for available updates in parallel. For the full interactive management interface, use [[cli/tui|npx quartz tui]] instead.