SiYuan Document Tool icon

SiYuan Document Tool

Use this tool to create, read, list, and manage documents in the SiYuan knowledge base. Use "getContent" to read a document, "create" to write a new one, "listInNotebook" to browse, or "exportMd" for full markdown export.

Actions6

Export Markdown

AI-generated

Overview

This node operation exports a document from the SiYuan knowledge base as Markdown along with its human-readable path. It is useful for users who want to extract and save the full Markdown content of a document for backup, sharing, or further processing outside the SiYuan environment.

Use Case Examples

  1. Exporting a project documentation page as Markdown to integrate with other documentation tools.
  2. Backing up notes or articles in Markdown format for offline access or version control.

Properties

Name Meaning
Document ID The unique ID of the document to export as Markdown.

Output

JSON

  • markdownContent - The exported Markdown content of the document.
  • docPath - The human-readable path of the document within the SiYuan knowledge base.

Dependencies

  • Requires an API key credential for SiYuan API authentication.

Troubleshooting

  • Ensure the Document ID is correct and exists in the SiYuan knowledge base to avoid errors.
  • Check API credentials and connectivity if the export operation fails due to authentication or network issues.
  • If the document is large, the export might take longer; consider handling timeouts or retries in workflows.

Links

  • SiYuan Knowledge Base - Official site for SiYuan knowledge base software, useful for understanding document management and API capabilities.

Discussion