7.7 KiB
7.7 KiB
The next generation PKM system, your digital garden
💡 Introduction
SiYuan is a local-first personal knowledge management system, support fine-grained block-level reference and Markdown instant-render editing.
✨ Features
- Content block
- Block-level reference and two-way links
- Document relationship diagram, global relationship diagram
- Bookmark collection
- Dynamic query embed
- URL for browser visit or link with other software
- Markdown
- Instant Rendering editing mode similar to Typora
- Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
- Paste HTML automatically converted to Markdown
- Configure Markdown to analyze detailed rendering parameters
- MinMap mode
- Support zoom, drag, layout and theme, etc.
- Keep editing and Markdown in sync
- Use on the browser, support mobile-end
- Hierarchical tag
- Multi-window, multi-tab, drag and drop to split screen
- WebDAV
- Fulltext search
- Themes and icons
- Built-in bright and dark themes
- Built-in two sets of icons, Material and Ant Design
- Support custom themes and icons
- Export
- Standard Markdown and TextBundle export
- Content block reference provides anchor text + embedded blockquote option
- Copy to WeChat MP, Zhihu and Yuque
- Versioning and Sync
🗺️ Roadmap
🛠️ Download Setup
To get the latest Insider Preview, please send an email with your GitHub login name to 845765@qq.com, and we will invite you to join the SiYuan Insider Preview team, thanks.
📜 Documentation
- User Guide
- SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application
- Markdown implements the exploration of block-level reference bidirectional links
🏘️ Community
💌 Participate in contribution
At present, some components of SiYuan are open source, and contributions are welcome.
🙏 Acknowledgement
SiYuan is made possible by the Vditor and Lute open source project and other open source software.
Kernel
- https://github.com/golang/go
BSD-3-Clause License - https://github.com/vanng822/css
MIT License - https://github.com/studio-b12/gowebdav
BSD-3-Clause License - https://github.com/88250/gulu
Mulan PSL v2 - https://github.com/olahol/melody
BSD-2-Clause License - https://github.com/Masterminds/sprig
MIT License - https://github.com/Xuanwo/go-locale
Apache-2.0 License - https://github.com/blastrain/vitess-sqlparser
Apache-2.0 License - https://github.com/common-nighthawk/go-figure
MIT License - https://github.com/dustin/go-humanize
MIT License - https://github.com/emirpasic/gods
BSD-2-Clause License - https://github.com/facette/natsort
BSD-3-Clause License - https://github.com/fsnotify/fsnotify
BSD-3-Clause License - https://github.com/gin-contrib/cors
MIT License - https://github.com/gin-gonic/gin
MIT License - https://github.com/go-git/go-git
Apache-2.0 License - https://github.com/jackpal/gateway
BSD-3-Clause License - https://github.com/mitchellh/go-ps
MIT License - https://github.com/mssola/user_agent
MIT License - https://github.com/panjf2000/ants
MIT License - https://github.com/parnurzeal/gorequest
MIT License - https://github.com/golang/crypto
BSD-3-Clause License - https://github.com/golang/net
BSD-3-Clause License - https://github.com/golang/text
BSD-3-Clause License - https://github.com/go-gorm/sqlite
MIT License - https://github.com/go-gorm/gorm
MIT License
UI
- https://github.com/microsoft/TypeScript
Apache-2.0 License - https://github.com/electron/electron
MIT License - https://github.com/d3/d3
BSD-3-Clause License - https://github.com/google/diff-match-patch
Apache-2.0 License - https://github.com/rtfpessoa/diff2html
MIT License - https://github.com/mozilla/pdfjs-dist
Apache-2.0 License - https://github.com/blueimp/JavaScript-MD5
MIT License - https://github.com/fex-team/kityminder-core
BSD-3-Clause License - https://github.com/codemirror/CodeMirror
MIT License - https://github.com/hakimel/reveal.js
MIT License