obsidian-markdown

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax. Use when working with .md files in Obsidian, or when the user mentions wikilinks, callouts, frontmatter, tags, embeds, or Obsidian notes.

By freestylefly · 476 installs

npx skills add freestylefly/canghe-skills --skill obsidian-markdown

Source repository · Upstream listing

Obsidian Flavored Markdown Skill This skill enables skills compatible agents to create and edit valid Obsidian Flavored Markdown, including all Obsidian specific syntax extensions. Overview Obsidian uses a combination of Markdown flavors: [CommonMark](https://commonmark.org/) [GitHub Flavored Markdown](https://github.github.com/gfm/) [LaTeX](https://www.latex project.org/) for math Obsidian specific extensions (wikilinks, callouts, embeds, etc.) Basic Formatting Paragraphs and Line Breaks Headings Text Formatting Style Syntax Example Output Bold text or text Bold Bold Italic text or text Italic Italic Bold + Italic text Both Both Strikethrough ~~text~~ ~~Striked~~ ~~Striked~~ Highlight ==text== ==Highlighted== ==Highlighted== Inline code code code code Escaping Formatting Use backslash to escape special characters: Common characters to escape: \ , \ , \ , \ , \ , \~ Internal Links (Wikilinks) Basic Links Link to Headings Link to Blocks Define a block ID by adding ^block id at the end of a paragraph: For lists and quotes, add the block ID on a separate line: Search Links Markdown Style Links Note: Spaces must be URL encoded as %20 in Markdown links. Embeds Embed Notes Embed Images External Images Embed Audio Embed PDF Embed Lists Where the list has been defined with a block ID: Embed Search Results query tag: project status:done Callouts Basic Callout Foldable Callouts Nested Callouts Supported Callout Types Type Aliases Description note Blue, pencil icon abstract summary , tldr Teal, clipboard icon info Blue, info icon todo Blue, checkbox icon tip hint , important Cyan, flame icon success check , done Green, checkmark icon question help , faq Yellow, question mark warning caution , attention Orange, warning icon failure fail , missing Red, X icon danger error Red, zap icon bug Red, bug icon example Purple, list icon quote cite Gray, quote icon Custom Callouts (CSS) Lists Unordered Lists Ordered Lists Task Lists Quotes Code Inline Code Code Blocks Plain code block javascript // Syntax highlighted code block function hello() { console.log("Hello, world!"); } python Python example def greet(name): print(f"Hello, {name}!") Nesting Code Blocks Use more backticks or tildes for the outer block: markdown Here's how to create a code block: Tables Alignment Using Pipes in Tables Escape pipes with backslash: Math (LaTeX) Inline Math Block Math Common Math Syntax Diagrams (Mermaid) mermaid graph TD A[Start] B{Decision} B Yes C[Do this] B No D[Do that] C E[End] D E Sequence Diagrams mermaid sequenceDiagram Alice Bob: Hello Bob Bob Alice: Hi Alice Linking in Diagrams mermaid graph TD A[Biology] B[Chemistry] A B class A,B internal link; Footnotes Comments Horizontal Rules Properties (Frontmatter) Properties use YAML frontmatter at the start of a note: Property Types Type Example Text title: My Title Number rating: 4.5 Checkbox completed: true Date date: 2024 01 15 Date & Time due: 2024 01 15T14:30:00 List tags: [one, two] or YAML list Links related: "[[Other Note]]" Default Properties tags Note tags aliases Alternative names for the note cssclasses CSS classes applied to the note Tags Tags can contain: Letters (any language) Numbers (not as first character) Underscores Hyphens Forward slashes / (for nesting) HTML Content Obsidian supports HTML within Markdown: Complete Example python def process data(items): return sorted(items, key=lambda x: x.priority) mermaid graph LR A[Input] B[Process] B C[Output] B D[Cache] References [Basic formatting syntax](https://help.obsidian.md/syntax) [Advanced formatting syntax](https://help.obsidian.md/advanced syntax) [Obsidian Flavored Markdown](https://help.obsidian.md/obsidian flavored markdown) [Internal links](https://help.obsidian.md/links) [Embed files](https://help.obsidian.md/embeds) [Callouts](https://help.obsidian.md/callouts) [Properties](https://help.obsidian.md/properties)