siyuan

Summarize Siyuan Notes core concepts and APIs in a concise primer.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill consolidates Siyuan Notes foundational knowledge, including block concepts, block references, embeds, API usage, templates, and flashcards, to help users understand and operate SiYuan efficiently.

Core Features & Use Cases

  • Foundational concepts: content blocks, block references, and embeds.
  • API basics: how to interact with Siyuan via REST/WS endpoints.
  • Templates & workflows: template syntax, blocks, and flashcard workflows for knowledge management.
  • Use Case: A new user wants to set up a local Siyuan environment and understand how to create blocks, references, and templates for daily notes.

Quick Start

Summarize the Siyuan Notes core concepts and APIs in a concise primer.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do block references and block embedding work in Siyuan Notes?

Block references in Siyuan Notes link directly to specific content blocks, while block embedding dynamically transcludes referenced blocks into your current document for consolidated knowledge management.

How do I use Siyuan Notes API endpoints for integration?

The Siyuan Notes API allows interaction via REST and WebSocket endpoints, enabling you to automate block operations, query content blocks, and integrate external applications with your local environment.

Can I create flashcards and templates using content blocks in Siyuan?

Yes, Siyuan supports flashcard workflows and template syntax using content blocks, allowing you to structure daily notes and schedule knowledge reviews directly within your local environment.

What is the best way to get started with Siyuan Notes core concepts?

To get started with Siyuan Notes core concepts, set up a local environment and learn foundational structures like content blocks, block references, and embeds for daily knowledge management.

Do I need a local environment to use Siyuan templates and APIs?

Yes, using Siyuan templates and APIs requires a local environment setup to interact with REST/WS endpoints, manage content blocks, and execute knowledge management workflows efficiently.