siyuan-markdown

Edit Siyuan notes with SFMarkdown to render wiki links, block references, and embedded blocks.

16|4|Updated Jan 27, 2026
One-click install
npx skills add https://github.com/zhiluop/siyuan-skills --skill siyuan-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan-markdown
Source: https://github.com/zhiluop/siyuan-skills/tree/main/skills/siyuan-markdown
Command: npx skills add https://github.com/zhiluop/siyuan-skills --skill siyuan-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires requests, and includes scripts (resource) components.

What problem does it solve?

This Skill enables writing and editing Siyuan-specific Markdown (SFMarkdown) with advanced features like wiki links, block references, embedded blocks, and property queries, simplifying note creation in Siyuan.

Core Features & Use Cases

  • Wiki links: Create [[document]] and [[document|alias]] links to navigate between notes.
  • Block references and embeds: Reference or embed specific blocks using ((blockID)) and the inline embedding syntax.
  • Attributes and SQL embeds: Attach custom properties to blocks and include SQL-enabled embeds to display dynamic data in notes.
  • Images and assets: Insert images via the provided scripts and store media under the assets/ directory.
  • Use Case: When drafting technical docs or knowledge bases in Siyuan, use SFMarkdown to maintain rich inter-document relationships.

Quick Start

Use the siyuan-markdown skill to format a note with [[Design Doc]], embed block ((20250125000000-1a2b3c4d)), and include an SQL embed to pull related data.

Frequently Asked Questions about siyuan-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write Siyuan notes with wiki links and block references?

To format Siyuan notes with wiki links and block references, use SFMarkdown syntax like [[document]] for navigation and ((blockID)) for references. This ensures correct rendering of inter-document relationships within your knowledge base.

What's the best way to embed blocks and run SQL queries in Siyuan markdown?

The best way to embed blocks and run SQL queries in Siyuan markdown is by using the inline embedding syntax and SQL embeds. This allows you to reference specific blocks and display dynamic data pulled from your notes.

Does this approach support custom attributes and property queries in Siyuan?

Yes, this SFMarkdown approach supports custom attributes and property queries in Siyuan. You can attach custom properties to blocks and include SQL-enabled embeds to display dynamic data across your documents.

Can I use standard markdown to create wiki links and block embeds for Siyuan?

No, standard markdown cannot create wiki links and block embeds for Siyuan. You must use Siyuan-flavored Markdown (SFMarkdown) to correctly parse and render features like [[wiki links]] and ((block references)).

How do I insert images and store media assets when drafting Siyuan notes?

To insert images and store media assets when drafting Siyuan notes, use the provided scripts to handle the media. The assets are automatically stored under the dedicated assets/ directory in your workspace.