quartz-community/tag-page
1
0
Fork 0
mirror of https://github.com/quartz-community/tag-page.git synced 2026-07-22 02:50:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
71 commits 1 branch 0 tags 364 KiB
TypeScript 98.3%
SCSS 1.7%
Find a file
saberzero1 82f8a6d5e7
chore: regenerate package-lock.json
2026-05-24 17:33:06 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:35 +02:00
dist build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:35 +02:00
src feat: wrap tag content in .markdown-preview-view and .markdown-rendered for Obsidian theme compat 2026-04-25 22:57:04 +02:00
test feat: exclude unlisted pages from tag discovery and listings 2026-04-11 13:51:04 +02:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:01:54 +01:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 18:36:35 +01:00
CHANGELOG.md feat: exclude unlisted pages from tag discovery and listings 2026-04-11 13:51:04 +02:00
LICENSE Initial commit 2026-02-13 18:36:35 +01:00
package-lock.json chore: regenerate package-lock.json 2026-05-24 17:33:06 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:24:43 +02:00
README.md docs: add prefixTags option to configuration table 2026-03-18 17:47:01 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 18:36:35 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:35 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@quartz-community/tag-page

Renders tag pages showing all content tagged with a specific tag. Automatically generates virtual pages for all tags found across content.

Installation

npx quartz plugin add github:quartz-community/tag-page

Usage

plugins:
  - source: github:quartz-community/tag-page
    enabled: true

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.TagPage({
  numPages: 10,
  prefixTags: false,
});

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").

Documentation

See the Quartz documentation for more information.

License

MIT