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
28 commits 1 branch 0 tags 200 KiB
TypeScript 100%
Find a file
saberzero1 09bd6a7dfd
deps: update @quartz-community/types and @quartz-community/utils
2026-04-16 13:25:03 +02:00
.github/workflows ci: add dist externals verification step 2026-03-17 19:41:47 +01:00
dist refactor: remove duplicate vfile DataMap fields now in @quartz-community/types 2026-04-03 15:44:03 +02:00
src refactor: remove duplicate vfile DataMap fields now in @quartz-community/types 2026-04-03 15:44:03 +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 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-04-16 13:25:03 +02:00
package.json fix: bundle non-shared deps into dist to prevent runtime resolution failures 2026-03-17 19:31:51 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +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 fix: move tsconfig from dts object to top-level option 2026-03-22 13:25:12 +01: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.

Documentation

See the Quartz documentation for more information.

License

MIT