Andreas/siyuan
1
0
Fork 0
mirror of https://github.com/siyuan-note/siyuan.git synced 2025-12-17 07:00:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
siyuan/README_en_US.md

136 lines
6.1 KiB
Markdown
Raw Normal View History

:memo: 更新自述
2020-09-10 16:01:59 +08:00
<p align="center">
<img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png">
<br>
<em>When one drinks water, one must not forget where it comes from</em>
<br><br>
<a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a>
<a title="Release Date" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release-date/siyuan-note/siyuan.svg?style=flat-square&color=99CCFF"></a>
<a title="Downloads" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet"></a>
:memo: 增加 Docker Pulls 徽标
2020-12-28 09:30:34 +08:00
<a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/b3log/siyuan"><img src="https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=FF96B4"></a>
:memo: 更新自述
2020-09-10 16:01:59 +08:00
<a title="Hits" target="_blank" href="https://github.com/siyuan-note/siyuan"><img src="https://hits.b3log.org/siyuan-note/siyuan.svg"></a>
</p>
<p align="center">
<a href="https://github.com/siyuan-note/siyuan/blob/master/README.md">中文</a>
</p>
## 💡 Introduction
:memo: 更新自述
2020-10-03 19:26:05 +08:00
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.
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:memo: 加入线上体验地址
2020-11-01 11:48:51 +08:00
Online experience: [https://ld246.com/xanadu/](https://ld246.com/xanadu/), welcome to [SiYuan Official Discussion Forum](https://ld246.com/tag/siyuan) to learn more.
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![desktop.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/desktop.png)
:memo: 更新自述
2020-10-06 09:22:23 +08:00
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![mobile.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/mobile.png)
:memo: 更新自述
2020-10-06 09:22:23 +08:00
:memo: 更新自述
2020-09-10 16:01:59 +08:00
## ✨ Features
:memo: 更新自述
2020-11-21 09:42:22 +08:00
* Born for Markdown
* Instant Rendering editing mode similar to Typora
:memo: 更新自述
2020-09-10 16:01:59 +08:00
* Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
* Paste HTML automatically converted to Markdown
* Configure Markdown to analyze detailed rendering parameters
:bookmark: 发布 v0.2.1
2020-09-23 20:21:49 +08:00
* Content block
:memo: 更新自述
2020-11-19 09:04:21 +08:00
* Block-level reference and two-way links
:bookmark: 发布 v0.2.1
2020-09-23 20:21:49 +08:00
* Document relationship diagram, global relationship diagram
* Bookmark collection
:memo: 更新自述
2020-11-19 08:56:17 +08:00
* Dynamic query embed
:memo: 更新自述
2020-11-19 09:04:21 +08:00
* URL for browser visit or link with other software
:camera_flash: 更新截图
2021-01-12 10:52:44 +08:00
* MinMap mode
* Support zoom, drag, layout and theme, etc.
* Keep editing and Markdown in sync
* Use on the browser, support mobile-end
:memo: 更新自述
2020-09-27 09:23:46 +08:00
* Hierarchical tag
* Multi-window, multi-tab, drag and drop to split screen
* WebDAV
:memo: 更新自述
2020-11-19 09:04:21 +08:00
* Versioning and Sync
:memo: 更新自述
2020-09-27 09:23:46 +08:00
* Fulltext search
:bookmark: 发布 v0.2.1
2020-09-23 20:21:49 +08:00
* Themes and icons
* Built-in bright and dark themes
* Built-in two sets of icons, Material and Ant Design
:bookmark: 发布 v0.2.1
2020-09-23 20:26:09 +08:00
* Support custom themes and icons
:bookmark: 发布 v0.2.1
2020-09-23 20:21:49 +08:00
* Export
:camera_flash: 更新截图
2021-01-12 10:52:44 +08:00
* Standard Markdown and TextBundle export
:memo: 更新自述
2020-11-19 08:57:07 +08:00
* Content block reference provides anchor text + embedded blockquote option
:memo: 更新自述
2020-10-03 19:20:36 +08:00
* Copy to WeChat MP, Zhihu
:memo: 更新自述
2020-11-19 09:04:21 +08:00
* Online Cloud workspace
* Online Publishing and Share
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:memo: 更新自述
2020-09-10 16:16:53 +08:00
## 🗺️ Roadmap
:memo: 更新自述
2020-09-10 16:01:59 +08:00
* [SiYuan development plan and progress](https://github.com/siyuan-note/siyuan/projects/1)
* [SiYuan Change logs](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
## 📸 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.
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![ir-block](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55de/screenshots/ir-block.gif)
:camera_flash: 更新截图
2021-01-12 10:52:44 +08:00
### Block move, fold and style
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![move-fold-style](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/move-fold-style.gif)
:camera_flash: 更新截图
2021-01-12 10:52:44 +08:00
### MindMap mode
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![mindmap](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/mindmap.png)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
### Roam
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![roam.gif](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/roam.gif)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:memo: 更新自述
2020-10-06 09:46:24 +08:00
### Settings
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![settings.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/settings.png)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:memo: 更新自述
2020-09-10 16:31:01 +08:00
### Search
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![search.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/search.png)
:memo: 更新自述
2020-09-10 16:31:01 +08:00
:memo: 更新自述
2020-09-10 16:01:59 +08:00
### Block Reference
:camera_flash: 更新截图
2021-01-12 17:12:33 +08:00
![blockref.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/block-ref.gif)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
:camera_flash: 更新截图
2020-11-19 08:54:13 +08:00
### Dynamic Query Embed
:camera_flash: 更新截图
2021-01-12 17:13:54 +08:00
![block-query-embed.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@cd71a68a0824355620172df836ce0ebe608a55d/screenshots/block-query-embed.gif)
:camera_flash: 更新截图
2020-11-19 08:54:13 +08:00
:memo: 更新自述
2020-09-10 16:04:41 +08:00
## 🛠️ Download Setup
:memo: 更新自述
2020-09-10 16:01:59 +08:00
* [GitHub](https://github.com/siyuan-note/siyuan/releases)
* [Gitee](https://gitee.com/siyuan-note/siyuan/releases)
:memo: 增加 Docker Pulls 徽标
2020-12-28 09:30:34 +08:00
* [Docker](https://hub.docker.com/r/b3log/siyuan)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
## 📜 Documentation
:memo: 增加 Docker Pulls 徽标
2020-12-28 09:30:34 +08:00
* [SiYuan User Guide](https://ld246.com/udanax/1602224134353)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
* [SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application](https://ld246.com/article/1598872180233)
* [Markdown implements the exploration of block-level reference bidirectional links](https://ld246.com/article/1597226949061)
## 🏘️ Community
* [SiYuan Issues](https://github.com/siyuan-note/siyuan/issues)
:memo: 加入参与贡献
2020-12-12 23:48:56 +08:00
[SiYuan Discussions](https://github.com/siyuan-note/siyuan/discussions)
:memo: 更新社区联系方式
2020-11-30 10:09:45 +08:00
* [SiYuan Customer Service Email](mailto:support@b3log.org)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
## 🙏 Acknowledgement
* [Vditor - Browser-side Markdown editor](https://github.com/Vanessa219/vditor)
* [Lute - A structured Markdown engine that supports Go and JavaScript](https://github.com/88250/lute)
* [GoWebDAV - Go WebDAV client lib](https://github.com/88250/gowebdav)
* [Gulu - Go commons utilities](https://github.com/88250/gulu)
:camera_flash: 更新截图
2020-11-19 08:54:13 +08:00
* [Melody - Go WebSocket framework](https://github.com/88250/melody)
:memo: 更新自述
2020-09-10 16:01:59 +08:00
* [Gin - Go Web framework](https://github.com/gin-gonic/gin)
* [Electron - Build cross-platform desktop apps with JavaScript, HTML, and CSS](https://github.com/electron/electron)
:memo: 加入参与贡献
2020-12-12 23:48:56 +08:00
## 💌 Participate in contribution
At present, some components of SiYuan are open source, and contributions are welcome.
* [User Guide](https://github.com/siyuan-note/user-guide-en_US)
* [Appearance and language](https://github.com/siyuan-note/appearance)
* [Markdown Engine](https://github.com/88250/lute)
Reference in a new issue Copy permalink