blossom/blossom-editor/README.md

58 lines
3.3 KiB
Markdown
Raw Normal View History

2023-09-01 02:05:22 +08:00
<p align="center">
2023-11-26 21:55:13 +08:00
<img src="../doc/imgs/blossom.png" height="200">
2023-09-01 02:05:22 +08:00
</p>
<p align="center" style="font-size: 30px;font-weight:500;">
2023-10-21 19:53:43 +08:00
Blossom
2023-09-01 02:05:22 +08:00
</p>
<p align="center">
2023-11-26 21:55:13 +08:00
<a href="https://www.wangyunf.com/blossom-doc/guide/tryuse.html">💻️ 试用</a> | <a href="https://www.wangyunf.com/blossom-doc/">📃 文档</a> | <a href="https://www.wangyunf.com/blossom-doc/guide/about/download.html">📥 下载</a>
2023-09-01 02:05:22 +08:00
</p>
---
2023-08-07 11:50:22 +08:00
2023-08-09 19:08:11 +08:00
Blossom 是一个支持**私有部署**的**云端存储双链笔记软件**你可以将你所有的笔记图片个人计划安排保存在自己的服务器中并在任意设备之间实时同步且基于MIT协议完全开源。
2023-08-07 11:50:22 +08:00
2023-09-21 22:02:17 +08:00
<p align="center">
2023-11-26 21:55:13 +08:00
<img src="../doc/imgs/home_light_and_dark.png">
2023-09-21 22:02:17 +08:00
</p>
2023-08-07 11:50:22 +08:00
2023-11-26 21:55:13 +08:00
- 你可以先进行[试用](https://www.wangyunf.com/blossom-doc/guide/tryuse.html),我们提供了一个试用账号帮你体验该应用。
- 使用 [Docker / Docker Compose](https://www.wangyunf.com/blossom-doc/guide/deploy/backend.html) 进行部署。
- 阅读[文档](https://www.wangyunf.com/blossom-doc/)来查看更多使用细节。
2023-08-07 11:50:22 +08:00
2023-08-09 14:34:10 +08:00
---
2023-08-07 11:50:22 +08:00
2023-11-02 23:40:15 +08:00
### 👏 Blossom 具有以下优势:
2023-08-07 11:50:22 +08:00
2023-08-09 14:34:10 +08:00
1. **不再需要为同步设备数量付费**
2. **不再需要为公网访问付费**
2023-11-02 23:54:18 +08:00
3. **不再需要为软件付费**,基于 MIT 协议完全开源。
2023-08-09 14:34:10 +08:00
4. **文章与图片都在你的服务器存储**,不需要再使用任何三方图床,不需要购买任何对象存储。
5. **没有任何私有协议**,基于 Markdown 语法,采用约定格式拓展样式。迁移到其他软件可以正常显示。
6. **多账号权限**,可以和你的朋友一起使用。或者将自己的生活/工作笔记存放在不同账号中。
2023-11-02 23:40:15 +08:00
7. **一键导出**,可以一键导出所有文章和图片,并将图片链接转换为本地路径,轻松成为本地笔记。
2023-09-21 22:02:17 +08:00
8. **网页转换**,可以一键将指定或全部文章转换为网页,方便分享。
2023-11-02 23:40:15 +08:00
9. **丰富的功能拓展**,包含日历计划,待办事项清单,是一个完善的个人管理工具。
10. **支持 Docker / Docker Compose 部署**
11. 不同于主流笔记软件的页面样式,为你提供一个新的选择。
### 🎁 Blossom 具有以下功能:
2023-08-07 11:50:22 +08:00
2023-09-01 02:05:22 +08:00
1. **文章编辑**Markdown 文章编写,文章公网访问权限,文章分类管理。
2. **双链笔记**:内部文章与外部链接引用形成的双链笔记知识网络。
2023-09-21 22:02:17 +08:00
3. **全量导出**:每日全量备份,备份一键下载。
4. **网页转换**:将 Markdown 文章转换成网页,一键打包分享。
2023-11-02 23:40:15 +08:00
5. **番茄时钟**:文章编辑中包含一个番茄钟功能。
2023-09-21 22:02:17 +08:00
6. **图片存储**:按文章目录分类你的图片,或自定义图片目录,图片与文章双向查询。
2023-11-02 23:40:15 +08:00
7. **自带截图**(仅 windows),你不再需要使用其他截图工具截图后保存在本地再上传到云端了。
2023-09-21 22:02:17 +08:00
8. **待办清单**:以 Todo List 的方式管理你的每日事项或阶段性计划。
9. **计划安排**:阶段性的长期计划,或者日历中的短期计划安排。
10. **快捷便签**:方便你记录随意的日常信息。
11. **网站收藏**:常用网站快捷访问,或者说是一个书签功能。
12. 笔记总字数折线图,笔记编辑数量热力图,服务器请求量折线图等多种统计。
2023-09-01 02:05:22 +08:00
2023-11-02 23:40:15 +08:00
# 🚀 Docker Compose 一键部署
```
docker compose -f docker/compose/blossom-mysql8.yaml up -d
2023-11-26 22:07:21 +08:00
```