GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2025-12-23 21:04:07 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update plugin documentation for broken link changes

Browse Source
This commit is contained in:
David Tobolik 2025-12-22 12:54:33 +01:00
parent 6ef6d837da
commit 8f7c8b4a89
No known key found for this signature in database
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/plugins/CrawlLinks.md
View File

@ -15,6 +15,11 @@ This plugin accepts the following configuration options:
- `absolute`: Path relative to the root of the content folder. - `absolute`: Path relative to the root of the content folder.
- `relative`: Path relative to the file you are linking from. - `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. - `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`). - `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`. - `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`. - `lazyLoad`: If `true`, adds lazy loading to resource elements (`img`, `video`, etc.) to improve page load performance. Defaults to `false`.

1
docs/plugins/ObsidianFlavoredMarkdown.md
View File

@ -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. - `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. - `enableVideoEmbed`: If `true` (default), enables the embedding of video files.
- `enableCheckbox`: If `true`, adds support for interactive checkboxes in content. Defaults to `false`. - `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] > [!warning]
> Don't remove this plugin if you're using [[Obsidian compatibility|Obsidian]] to author the content! > Don't remove this plugin if you're using [[Obsidian compatibility|Obsidian]] to author the content!