@quartz-community/tag-page 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.0.5
+
+### Patch Changes
+
+- 56dd9d8: The manifest declares the `prefixTags` option (default `false`), so option checks and Quartz Syncer know it.
+
+## 1.0.4
+
+### Patch Changes
+
+- 4487502: The `numPages` and `sort` options take effect. Quartz builds a page type's body with `body(undefined)`, and the tag listing was passed in directly, so it never received the plugin's options and always used its defaults.
+
 ## 1.0.3
 
 ### Patch Changes

package/README.md

@@ -5,35 +5,44 @@ Renders tag pages showing all content tagged with a specific tag. Automatically
 ## Installation
 
 ```bash
-npx quartz plugin add github:quartz-community/tag-page
+npx quartz plugin add @quartz-community/tag-page
 ```
 
+Tag pages are already in Quartz's default configuration.
+
 ## Usage
 
 ```yaml title="quartz.config.yaml"
 plugins:
-  - source: github:quartz-community/tag-page
+  - source: "@quartz-community/tag-page"
     enabled: true
+    options:
+      numPages: 10
+      prefixTags: false
 ```
 
-For advanced use cases, you can override in TypeScript:
+`sort` takes a function, so it needs a TypeScript override:
 
 ```ts title="quartz.ts (override)"
 import * as ExternalPlugin from "./.quartz/plugins";
 
 ExternalPlugin.TagPage({
   numPages: 10,
-  prefixTags: false,
+  sort: (f1, f2) => (f1.frontmatter?.title ?? "").localeCompare(f2.frontmatter?.title ?? ""),
 });
 ```
 
 ## Configuration
 
-| Option       | Type      | Default     | Description                                                                     |
-| ------------ | --------- | ----------- | ------------------------------------------------------------------------------- |
-| `sort`       | `SortFn`  | `undefined` | A function to sort the pages with the tag.                                      |
-| `numPages`   | `number`  | `undefined` | The number of pages to show per tag page.                                       |
-| `prefixTags` | `boolean` | `false`     | Whether to prefix generated tag page titles with "Tag: " (e.g. "Tag: recipes"). |
+| Option       | Type      | Default                         | Description                                                                                                                                          |
+| ------------ | --------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `numPages`   | `number`  | `10`                            | On the tag index page (`/tags`), the maximum number of pages listed under each tag; a tag's own page lists all of them.                              |
+| `prefixTags` | `boolean` | `false`                         | Whether to prefix generated tag page titles with the localized "Tag" label (e.g. "Tag: recipes").                                                    |
+| `sort`       | `SortFn`  | folders first, then date, title | A function `(f1, f2) => number` to sort the pages with the tag. By default: folders first, then newest first, then by title. Requires a TS override. |
+
+`numPages` and `sort` take effect since version 1.0.4.
+
+A page with a nested tag such as `#project/alpha` is listed under both `project/alpha` and `project`. Writing a note at `tags/<tag>.md` adds your own text above the generated listing.
 
 ## Documentation
 

package/dist/index.js

@@ -2897,7 +2897,9 @@ var TagPage = (opts) => ({
     return virtualPages;
   },
   layout: "tag",
-  body: TagContent_default
+  // Quartz calls body(undefined): pass this plugin's options through, or numPages and sort
+  // never reach the tag listing
+  body: () => TagContent_default(opts)
 });
 
 export { TagContent_default as TagContent, TagPage };