Browse Source

change readme

master
godo 10 months ago
parent
commit
24390ebbb4
  1. 4
      README.en.md
  2. 6
      README.md
  3. 55
      docs/Markdown.md
  4. 2081
      frontend/pnpm-lock.yaml

4
README.en.md

@ -31,11 +31,11 @@ English | [简体中文](README.md)
[MacOS-image]: ./docs/img/MacOS.svg
[MacOS-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-macos.dmg
[MacOS-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-macos-amd64.zip
[Linux-image]: ./docs/img/Linux.svg
[Linux-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-linux
[Linux-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-linux-amd64.zip
</div>

6
README.md

@ -33,11 +33,11 @@
[MacOS-image]: ./docs/img/MacOS.svg
[MacOS-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-macos.dmg
[MacOS-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-macos-amd64.zip
[Linux-image]: ./docs/img/Linux.svg
[Linux-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-linux
[Linux-url]: https://gitee.com/ruitao_admin/godoos/releases/download/v1.0.0/godoos-linux-amd64.zip
</div>
@ -74,7 +74,7 @@
<img src="./docs/img/file.png" width="600" />
### 三、内网聊天
- 无需繁琐的注册流程,只需在同一局域网内,即可自动发现并列出所有可用的聊天对象,即刻开启即时通讯。支持基于局域网的即时消息传输、文件传输等功能,促进团队内部的无缝沟通与协作
- 无需注册流程,只需在同一内,即可自动发现并列出所有可用的聊天对象,支持基于局域网的即时消息传输、文件传输等功能。
<img src="./docs/img/localchat.png" width="600" />
### 四、文档

55
docs/Markdown.md

@ -0,0 +1,55 @@
---
title: Markdown编辑器
icon: circle-info
---
## 概览
Markdown 编辑器允许您使用丰富的文本编辑体验创建和编辑 Markdown 文件。它包括实时保存、文件导入/导出以及访问最近的 Markdown 文件等功能。
## 开始使用
### 打开编辑器
- 通过应用程序菜单或快捷方式访问 Markdown 编辑器。
### 编辑内容
- 使用编辑器界面,利用 Markdown 语法输入和格式化文本。
- 编辑器支持 Markdown 格式的实时预览。
### 保存更改
- 当编辑器处于聚焦状态时,按 `Ctrl+S` (`Cmd+S` 在 Mac 上) 来保存更改。
- 或者,点击工具栏中的保存按钮。
### 导入文件
- 点击上传按钮或使用文件输入对话框来导入现有的 Markdown 文件。
- 文件的内容将加载到编辑器中,并且其标题将设置为文件名。
### 导出文件
- 点击下载按钮以导出当前的 Markdown 文档。
- 文件将以 Markdown 格式保存到您的本地存储中。
### 查看最近的文件
- 通过点击工具栏中的菜单按钮切换抽屉,以查看最近的文件。
- 抽屉列出您最近访问过的 Markdown 文件及其标题和最后修改时间。
## 界面组件
### 工具栏
- **菜单按钮**:打开抽屉以显示最近的文件。
- **上传按钮**:触发文件输入对话框以导入 Markdown 文件。
- **下载按钮**:将当前文档导出为 Markdown 文件。
- **保存按钮**:将当前文档保存到指定路径。
### 标题输入框
- 在这里输入您的 Markdown 文档的标题。
### 编辑区域
- 这里是您撰写和编辑 Markdown 内容的地方。
### 抽屉
- 显示最近访问过的 Markdown 文件列表。
## 小贴士
- 在尝试保存或导出文档之前,请确保文档有标题。
- 编辑器会在您按下保存快捷键或点击保存按钮时自动保存更改。
- 利用抽屉可以快速在最近的文档之间切换,而不会丢失工作进度。
---
本手册提供了全面的指南,帮助您有效地使用 Markdown 编辑器。遵循这些说明,最大化您的写作和编辑体验。

2081
frontend/pnpm-lock.yaml

File diff suppressed because it is too large
Loading…
Cancel
Save