quartz-community/content-index
1
0
Fork 0
mirror of https://github.com/quartz-community/content-index.git synced 2026-07-22 02:50:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
48 commits 1 branch 0 tags 260 KiB
TypeScript 100%
Find a file
saberzero1 c3d4f5c853
chore(deps): update @quartz-community/utils
2026-06-03 15:26:05 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:33 +02:00
dist chore(deps): update @quartz-community/utils 2026-06-03 15:26:05 +02:00
src refactor: import SimpleSlug from upstream types 2026-04-16 15:25:49 +02:00
test feat: respect file.data.unlisted and skip richContent for encrypted pages 2026-04-11 13:49:16 +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 21:57:34 +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 23:35:13 +01:00
CHANGELOG.md feat: respect file.data.unlisted and skip richContent for encrypted pages 2026-04-11 13:49:16 +02:00
LICENSE Initial commit 2026-02-13 23:35:13 +01:00
package-lock.json chore(deps): update @quartz-community/utils 2026-06-03 15:26:05 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:23:44 +02:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json feat: respect file.data.unlisted and skip richContent for encrypted pages 2026-04-11 13:49:16 +02:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:33 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@quartz-community/content-index

Generates a sitemap, RSS feed, and content index JSON for full-text search.

Installation

npx quartz plugin add github:quartz-community/content-index

Usage

plugins:
  - source: github:quartz-community/content-index
    enabled: true
    options:
      enableSiteMap: true
      enableRSS: true

For advanced use cases, you can override in TypeScript:

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

ExternalPlugin.ContentIndex({
  enableSiteMap: true,
  enableRSS: true,
  rssLimit: 10,
  rssFullHtml: false,
  rssSlug: "index",
  includeEmptyFiles: true,
});

Configuration

Option Type Default Description
enableSiteMap boolean true Whether to generate a sitemap.xml file.
enableRSS boolean true Whether to generate an RSS feed.
rssLimit number 10 Maximum number of items to include in the RSS feed.
rssFullHtml boolean false Whether to include full HTML content in the RSS feed.
rssSlug string "index" The slug for the RSS feed file.
includeEmptyFiles boolean true Whether to include empty files in the content index.

Documentation

See the Quartz documentation for more information.

License

MIT