Introduction to SiYuan
SiYuan is an innovative personal knowledge management system that emphasizes privacy, enabling users to manage their thoughts and information seamlessly. It features fine-grained block-level reference and a Markdown WYSIWYG (What You See Is What You Get) editor, promoting an efficient, structured way to handle personal knowledge.
Features
SiYuan is rich in features, offering most functions free for both personal and commercial use. Some highlights include:
- Content Blocks: These allow block-level referencing and two-way links with custom attributes, SQL query embedding, and a unique protocol
siyuan://. - Editor: It offers a block-style layout with Markdown WYSIWYG, the ability to create outlines and block zoom-ins for detailed views. It supports editing large documents (up to a million words), mathematical formulas, various charts, and even web clipping.
- Export Options: You can export your content in standard Markdown, PDF, Word, HTML formats, or share directly to platforms like WeChat MP and Zhihu.
- Database Views and Flashcards: SiYuan supports flashcard spaced repetition for efficient learning, and table views for database-style interactions.
- AI Integration: Users can leverage OpenAI API for writing assistance and interactive Q&A.
- Tech Features: It includes Tesseract OCR, multi-tab browsing, drag-and-drop to split screens, and support for Android/iOS apps.
- Deployment: Options to deploy using Docker are available.
- Community Support: A vibrant marketplace ecosystem is available for templates, plugins, and more.
Certain advanced features are reserved for paid members. Information on pricing is available on their website.
Architecture and Ecosystem
SiYuan is built on a robust architecture, interacting seamlessly with various tools and extensions:
- Lute: The editor engine powering SiYuan.
- Chrome/Edge Extensions: These extensions enhance the web browsing experience by allowing direct interaction with SiYuan.
- Bazaar: A community marketplace where users can exchange resources.
- Plugins and APIs: Customization is further extended via plugin APIs, allowing for tailored user experiences on multiple platforms, including Android and iOS.
Development and Community
The SiYuan community offers multiple resources:
- Discussion Forums: A place for users to discuss, share ideas, and get help.
- Contributor Guides: Detailed documentation for those wishing to contribute to SiYuan’s ongoing development.
FAQ
Data Storage
SiYuan uses a structured folder system to store data, including assets and emoji images. It employs JSON for document storage within custom .sy files.
Data Synchronization
Currently, SiYuan does not support third-party sync disk integration to avoid data corruption, though integration with third-party cloud storage is available for members. Users can manually export and import data across devices.
Open Source
SiYuan is fully open source with repositories available for different platforms and functionalities. Contributions are welcome.
Updates
Users are encouraged to use app stores for updates. Alternatively, SiYuan provides settings for automatic update checks to ensure users have the latest version installed.
Conclusion
SiYuan provides a comprehensive solution for personal knowledge management, equipped with advanced features and supported by a dynamic community. Whether used for personal organization or collaborative efforts, SiYuan stands out as a powerful tool designed for the informed individual.