From 8f7c8b4a89d96f8eab00d144f4e4ddde5aeb29bc Mon Sep 17 00:00:00 2001 From: David Tobolik Date: Mon, 22 Dec 2025 12:54:33 +0100 Subject: [PATCH] docs: update plugin documentation for broken link changes --- docs/plugins/CrawlLinks.md | 5 +++++ docs/plugins/ObsidianFlavoredMarkdown.md | 1 - 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/plugins/CrawlLinks.md b/docs/plugins/CrawlLinks.md index 47b7bdd77..1a44a4f1a 100644 --- a/docs/plugins/CrawlLinks.md +++ b/docs/plugins/CrawlLinks.md @@ -15,6 +15,11 @@ This plugin accepts the following configuration options: - `absolute`: Path relative to the root of the content folder. - `relative`: Path relative to the file you are linking from. - `shortest`: Name of the file. If this isn't enough to identify the file, use the full absolute path. +- `checkBrokenWikilinks`: Whether to check for broken wikilinks. Defaults to `true`. +- `onBrokenWikilink`: What to do with broken wikilinks. Can be `"disable"` (default), `"remove"`, or `"error"`. + - `disable`: Keep the link as is, but add the `broken` class. + - `remove`: Remove the link, leaving only the text. + - `error`: Throw an error and stop the build. - `prettyLinks`: If `true` (default), simplifies links by removing folder paths, making them more user friendly (e.g. `folder/deeply/nested/note` becomes `note`). - `openLinksInNewTab`: If `true`, configures external links to open in a new tab. Defaults to `false`. - `lazyLoad`: If `true`, adds lazy loading to resource elements (`img`, `video`, etc.) to improve page load performance. Defaults to `false`. diff --git a/docs/plugins/ObsidianFlavoredMarkdown.md b/docs/plugins/ObsidianFlavoredMarkdown.md index 277c7720b..414f743b8 100644 --- a/docs/plugins/ObsidianFlavoredMarkdown.md +++ b/docs/plugins/ObsidianFlavoredMarkdown.md @@ -23,7 +23,6 @@ This plugin accepts the following configuration options: - `enableYouTubeEmbed`: If `true` (default), enables the embedding of YouTube videos and playlists using external image Markdown syntax. - `enableVideoEmbed`: If `true` (default), enables the embedding of video files. - `enableCheckbox`: If `true`, adds support for interactive checkboxes in content. Defaults to `false`. -- `disableBrokenWikilinks`: If `true`, replaces links to non-existent notes with a dimmed, disabled link. Defaults to `false`. > [!warning] > Don't remove this plugin if you're using [[Obsidian compatibility|Obsidian]] to author the content!