Siyuan Share is a free and open-source plugin for Siyuan Note that allows you to generate accessible share links for notebooks, single documents, or documents with their subdocuments.
It supports access passwords, expiration time, and visitor limits, and provides an access statistics overview, making it suitable for knowledge sharing, collaboration, and temporary public publishing.
🌍 Documentation Languages:
中文 README ｜ English README
📝 Documentation:
Beginner-Friendly Tutorial Guide
🌐 Ready to Use, Flexible Deployment
The tool is completely free and open-source. You can start instantly via share.b0x.top or choose self-hosting (supports Docker / NAS / BT-Panel / other panels).
🎯 Flexible Sharing, Precise Control
Share a single page, sub-documents, or an entire notebook. You can exclude specific documents with one click to ensure private content stays private.
⚡ Efficient Sync, Built-in Analytics
Uses an incremental update algorithm (faster and saves data). Features built-in analytics, allowing you to track visitor counts, locations, and other key insights at a glance.
🔄 Auto-Update: Effortless & Worry-free
Once enabled, it automatically detects document changes in the background and updates the shared page, eliminating the need for repeated manual updates. It also provides running status, queues, and history logs to ensure your shared content is always up to date.
In the Document Tree, right-click on a notebook or document → open the Plugin Menu to access the following features:
- 🆕 Create Share / Manage Share
- 🔄 Update Share
- 📋 Copy Share Link
- 🗑️ Delete Share
Go to the Plugin Settings page to view the list of all created shares and manage them centrally.
-
Access Password
Set a password for the share. Visitors must enter the correct password to view the content. -
Expiration Time
After the expiration time, the share will be marked as expired and cannot be accessed.⚠️ Cloud data will not be automatically deleted. You can manually clean it up to save storage space. -
Visitor Limit
Set the maximum number of visitors.- Once the limit is reached, new visitors cannot access the share
- Visitors who have already accessed it can continue to visit
- Multiple visits from the same browser are counted as one visitor
-
Link Suffix
Customize the suffix of the share link.
-
Content Update Mechanism
- If you modify the document or notebook content, please use "Update Share"
→ This keeps the original share link unchanged while synchronizing the latest content - If you only modify access settings (password / expiration time / visitor limit / link suffix), please use "Update Access Settings"
→ No need to re-upload content, saving time and bandwidth
- If you modify the document or notebook content, please use "Update Share"
-
Link Change Rules
If you "Delete Share" and then "Create Share" again,
👉 The system will generate a new share link, and the old link will immediately become invalid.👉 If needed, you can restore the previous link format by modifying the link suffix in the access settings.
This plugin relies on a server-side website:
🌐 share.b0x.top (used for data storage and access)
-
Register an account on the server website
-
Generate an API Key on the website
-
Enter the API Key into the plugin settings
-
After configuration, you can start sharing
Sharing essentially uploads the corresponding document or notebook to the server
-
Public Service
The currentshare.b0x.topis a public server provided by the author,
mainly intended for feature experience and short-term use. -
Data Cleanup Policy
Due to bandwidth and storage limitations,
large documents or notebooks may be cleaned up periodically. -
Private Deployment Recommendation (Strongly Recommended)
If you need long-term sharing,
please refer to 👉 Server Deployment Guide
to deploy your own private server.
Using notebook sharing as an example. Single document or document with subdocuments sharing is also supported.
If you find this project helpful, feel free to support the author ❤️
Your support motivates me to continuously maintain and improve this tool.
WeChat Pay
Alipay
Your support is the greatest motivation for continuous iteration 🙏
-
🐞 Issue Reporting:
GitHub Issues -
📄 License:
MIT License -
🧾 Changelog:
CHANGELOG.md -
🏅 Contributors:
Contributors List -
💖 Sponsors:
Sponsor List