$ show siyuan-note/siyuan
SiYuan is a privacy-first, local-first personal knowledge management system with a block-based WYSIWYG editor, AI assistant integration, cloud sync, and a plugin ecosystem. It is architected as a Go kernel (Gin HTTP API + WebSocket) paired with a TypeScript/Electron frontend, supporting desktop (Windows, macOS, Linux), mobile (Android, iOS, HarmonyOS), and browser/Docker deployment. The kernel handles all data operations: block tree persistence as JSON `.sy` files, SQLite indexing with FTS5 and SQLCipher encryption, attribute-view databases (tables, galleries, kanban), backlink resolution, full-text search, and sync via multiple providers (SiYuan cloud, S3, WebDAV, LAN). The frontend provides a rich editing experience with Markdown, LaTeX, Mermaid, mind maps, PDF annotation, flashcards (FSRS), and an agent chat interface. External dependencies include the Lute Markdown parser, dejavu sync library, Pandoc for document conversion, and PDF.js for PDF rendering. The system exposes a comprehensive REST API with contract-based validation and auto-generated TypeScript types, enabling third-party integrations and a community marketplace for plugins, themes, and templates.
The LLM identified 3 files worth highlighting for reuse:
A contract-driven API layer that defines typed request/response structs, custom decoders for legacy payloads, and automated validation via `contractHandler`. It generates TypeScript type definitions and enforces schema compliance across HTTP, WebSocket, and SSE endpoints. This pattern is self-contained and could be extracted to build type-safe API boundaries in any Go+TypeScript project, reducing drift between backend and frontend.
A generic `createConfigNamespaceApi<T>` factory that provides typed get/set/patch operations for configuration sections. It uses an immutable patch queue with dotted-path resolution and batch save deferral, ensuring consistent state updates across the application. This pattern is reusable for any settings system that requires atomic, side-effect-driven configuration changes.
A type-safe command registry that allows registration of commands with context-based availability checks. Commands are resolved by ID and can be executed with a snapshot of the current application context (editor, file tree, dock). This pattern decouples command definitions from their invocation and is reusable in any application requiring a keyboard shortcut or palette-driven command system.