mirror of https://github.com/quartz-community/crawl-links.git synced 2026-07-22 02:50:29 +00:00

No description

Find a file

saberzero1 5ccbcb5f3a fix: resolve ESLint and formatting issues for CI compliance		2026-03-09 03:47:47 +01:00
.github/workflows	Initial commit	2026-02-13 21:41:03 +01:00
src	fix: resolve ESLint and formatting issues for CI compliance	2026-03-09 03:47:47 +01:00
.eslintrc.json	Initial commit	2026-02-13 21:41:03 +01:00
.gitignore	Initial commit	2026-02-13 21:41:03 +01:00
.prettierrc	Initial commit	2026-02-13 21:41:03 +01:00
CHANGELOG.md	Initial commit	2026-02-13 21:41:03 +01:00
LICENSE	Initial commit	2026-02-13 21:41:03 +01:00
package-lock.json	deps: update @quartz-community/types and @quartz-community/utils	2026-03-09 03:03:56 +01:00
package.json	fix: move tsup and typescript to dependencies for git install compatibility	2026-02-23 01:09:46 +01:00
README.md	docs: update README for v5 unified config system	2026-02-25 16:07:03 +01:00
tsconfig.json	Initial commit	2026-02-13 21:41:03 +01:00
tsup.config.ts	feat: extract crawl links transformer from Quartz core	2026-02-13 22:31:24 +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.

Installation

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

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",
});

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.

See the Quartz documentation for more information.

MIT