@quartz-community/obsidian-flavored-markdown 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial Quartz community plugin template.
+
+### Changed
+
+- **BREAKING (inherited from `@quartz-community/utils`)**: wikilink targets are now lowercased when slugified (e.g. `[[My Note]]` resolves to `my-note` instead of `My-Note`). This matches Obsidian's case-insensitive link-matching behavior.
+
+### Removed
+
+- **BREAKING**: `disableBrokenWikilinks` option. The broken-link check has been moved to `@quartz-community/crawl-links`, which owns link resolution and can honor its own `markdownLinkResolution` strategy without the two plugins drifting. Users who had `disableBrokenWikilinks: true` under `ObsidianFlavoredMarkdown` must move it to `CrawlLinks`. The new location also covers broken markdown links (e.g. `[text](./nowhere)`), not just wikilinks.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quartz Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @quartz-community/obsidian-flavored-markdown
+
+Transforms Obsidian-specific markdown syntax including wikilinks, callouts, highlights, mermaid diagrams, tags, and media embeds.
+
+## Installation
+
+```bash
+npx quartz plugin add github:quartz-community/obsidian-flavored-markdown
+```
+
+## Usage
+
+```yaml title="quartz.config.yaml"
+plugins:
+  - source: github:quartz-community/obsidian-flavored-markdown
+    enabled: true
+    options:
+      enableInHtmlEmbed: false
+      enableCheckbox: true
+```
+
+For advanced use cases, you can override in TypeScript:
+
+```ts title="quartz.ts (override)"
+import * as ExternalPlugin from "./.quartz/plugins";
+
+ExternalPlugin.ObsidianFlavoredMarkdown({
+  enableInHtmlEmbed: false,
+  enableCheckbox: true,
+});
+```
+
+## Configuration
+
+| Option                 | Type      | Default | Description                                 |
+| ---------------------- | --------- | ------- | ------------------------------------------- |
+| `comments`             | `boolean` | `true`  | Whether to parse Obsidian-style comments.   |
+| `highlight`            | `boolean` | `true`  | Whether to parse Obsidian-style highlights. |
+| `wikilinks`            | `boolean` | `true`  | Whether to parse wikilinks.                 |
+| `callouts`             | `boolean` | `true`  | Whether to parse callouts.                  |
+| `mermaid`              | `boolean` | `true`  | Whether to parse Mermaid diagrams.          |
+| `parseTags`            | `boolean` | `true`  | Whether to parse tags.                      |
+| `parseBlockReferences` | `boolean` | `true`  | Whether to parse block references.          |
+| `enableInHtmlEmbed`    | `boolean` | `false` | Whether to enable parsing in HTML embeds.   |
+| `enableYouTubeEmbed`   | `boolean` | `true`  | Whether to enable YouTube embeds.           |
+| `enableVideoEmbed`     | `boolean` | `true`  | Whether to enable video embeds.             |
+| `enableCheckbox`       | `boolean` | `false` | Whether to enable checkboxes.               |
+
+## Documentation
+
+See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/ObsidianFlavoredMarkdown) for more information.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { QuartzTransformerPlugin } from '@quartz-community/types';
+export { QuartzTransformerPlugin } from '@quartz-community/types';
+
+interface ObsidianFlavoredMarkdownOptions {
+    comments: boolean;
+    highlight: boolean;
+    wikilinks: boolean;
+    callouts: boolean;
+    mermaid: boolean;
+    parseTags: boolean;
+    parseBlockReferences: boolean;
+    enableInHtmlEmbed: boolean;
+    enableYouTubeEmbed: boolean;
+    enableTweetEmbed: boolean;
+    enableVideoEmbed: boolean;
+    enableCheckbox: boolean;
+    enableObsidianUri: boolean;
+}
+declare const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<ObsidianFlavoredMarkdownOptions>>;
+
+export { ObsidianFlavoredMarkdown, type ObsidianFlavoredMarkdownOptions };