Quartz's default crawl links plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 05:04:27 +01:00
.changeset chore: version package 2026-11-09 04:03:24 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:25 +01:00
src fix(links): slug same-page #anchor links like heading ids (crawl-links#4) 2026-11-08 19:21:05 +01:00
test fix(links): slug same-page #anchor links like heading ids (crawl-links#4) 2026-11-08 19:21:05 +01: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: migrate to npm publishing 2026-07-23 09:06:57 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 21:41:03 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:03:24 +00:00
LICENSE Initial commit 2026-02-13 21:41:03 +01:00
package-lock.json chore: version package 2026-11-09 04:03:24 +00:00
package.json chore: version package 2026-11-09 04:03:24 +00:00
README.md docs: note that this plugin is built into Quartz 5.1+ 2026-11-07 13:15:33 +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 21:41:03 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:51:13 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/crawl-links

Processes and resolves internal and external links, tracks outgoing links, and optionally adds external link icons.

Important

Built into Quartz 5.1+. Link processing is part of Quartz core now, configured under configuration.links in quartz.config.yaml — you don't need this plugin anymore. Existing config entries for it keep working (Quartz applies their options to the built-in and doesn't load this package); run npx quartz plugin doctor --fix to update your config. See Built-in processing. This package is kept for Quartz versions before 5.1.

Installation

npx quartz plugin add github:quartz-community/crawl-links

Usage

plugins:
  - source: github:quartz-community/crawl-links
    enabled: true
    options:
      markdownLinkResolution: shortest

For advanced use cases, you can override in TypeScript:

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

ExternalPlugin.CrawlLinks({
  markdownLinkResolution: "shortest",
});

Configuration

Option Type Default Description
markdownLinkResolution "absolute" | "relative" | "shortest" "absolute" How to resolve internal links.
prettyLinks boolean true Whether to use pretty links.
openLinksInNewTab boolean false Whether to open links in a new tab.
lazyLoad boolean false Whether to lazy load links.
externalLinkIcon boolean true Whether to add an external link icon.
disableBrokenWikilinks boolean false When true, internal links whose resolved slug is not in ctx.allSlugs gain a broken CSS class (alongside internal) for styling.

Documentation

See the Quartz documentation for more information.

License

MIT