mirror of
https://github.com/siyuan-note/siyuan.git
synced 2025-05-02 16:10:26 +08:00
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
ankichatgptelectronevernoteknowledge-baselocal-firstmarkdownnote-takingnotebooknotes-appnotionobsidianocropenaipdfpkms3self-hostedwebdav
| .github | ||
| screenshots | ||
| .gitignore | ||
| CHANGE_LOGS.md | ||
| README_en_US.md | ||
| README_zh_CN.md | ||
| README.md | ||
The next generation of the note-taking system, built for the future
💡 Introduction
SiYuan is a desktop Markdown Block-Reference and Bidirectional-Link note-taking application, supports Windows, Mac and Linux, can be used directly on the browser, and supports mobile-end adaptation.
The online experience of share publishing: https://ld246.com/udanax/1602224134353, welcome to SiYuan Official Discussion Forum to learn more.
✨ Features
- Born for 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
- 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
- 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
- Versioning and Sync
- 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
- Online Cloud workspace
- Online Publishing and Share
🗺️ Roadmap
📸 Screenshots
Instant Rendering
Instant Rendering mode should not be unfamiliar to users who are familiar with Typora. In theory, this is the most elegant Markdown editing method.
Block move, fold and style
MindMap mode
Roam
Settings
Search
Block Reference
Dynamic Query Embed
Community theme bazaar
🛠️ Download Setup
📜 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