quartz-community/crawl-links
1
0
Fork 0
mirror of https://github.com/quartz-community/crawl-links.git synced 2026-07-22 02:50:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
44 commits 1 branch 0 tags 200 KiB
TypeScript 100%
Find a file
saberzero1 43edc6d518
chore(deps): update @quartz-community/utils
2026-06-03 15:26:45 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:39 +02:00
dist chore(deps): update @quartz-community/utils 2026-06-03 15:26:45 +02:00
src fix: add frontmatter links to the existing links set 2026-05-22 02:51:18 +02:00
test test: frontmatter links merging 2026-05-22 02:51:33 +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:48 +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 21:41:03 +01:00
CHANGELOG.md feat: add disableBrokenWikilinks option 2026-04-16 22:19:29 +02:00
LICENSE Initial commit 2026-02-13 21:41:03 +01:00
package-lock.json chore(deps): update @quartz-community/utils 2026-06-03 15:26:45 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:23:49 +02:00
README.md feat: add disableBrokenWikilinks option 2026-04-16 22:19:29 +02: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: bundle dependencies and ship pre-built dist 2026-04-27 21:37:39 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@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

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