SiYuan Note Document Export

Automation and Archiving Pain Points

Many teams keep notes in local SiYuan note libraries, but hand exports are fragile when documents need to be delivered, archived, or passed into later document pipelines. Nested child pages and external image assets can make manual export messy, while raw API calls may return scattered results. SiYuan Note Document Export turns a selected note into a usable .docx file and returns structured JSON, so scripts or LLM workflows can consume the result directly.

How It Works

The skill uses the native SiYuan API and calls POST /api/export/exportDocx to export a document. With removeAssets=true, image resources are embedded into the Word file, reducing the need for an external asset directory. It supports locating notes by document ID, human-readable path, or name search. In batch mode, child pages can be exported together, and the parent document can be included when needed, with output written to the desktop by default. Because it relies only on the Python standard library, it fits local automation environments without extra build steps.

Boundaries

SiYuan must be running, and a valid token must be configured. The skill focuses on Word export and child-document batch export; it does not replace full layout design, template styling, or cross-platform sync. Export fidelity for complex formulas, charts, or special styles still depends on how well Word handles the original content.