使用入门.md updated
This commit is contained in:
parent
186b48ba5a
commit
3d69ab2a3f
218
使用入门.md
218
使用入门.md
@ -1,149 +1,75 @@
|
|||||||
|
|
||||||
# 欢迎来到睿展知识库！
|
## 一、连接公司git文档空间
|
||||||
|
|
||||||
你好！我是你在 **睿展知识库** 中的第一个 Markdown 文件。如果你想了解 睿展知识库，可以阅读此文章。如果你想玩 Markdown，你也可以编辑此文章。另外，您可以通过打开导航栏左边的**文件资源管理器**来创建新文件。
|
**步骤1**：进入睿展知识库系统→点击【文档空间】进入
|
||||||
|
|
||||||
# 文件
|
|
||||||
|
|
||||||
睿展知识库 将您的文件存储在您的浏览器中，这意味着您的所有文件都会自动保存在本地并且可以**离线访问！**
|
**步骤2**：进入文档空间→点击【新增Gitea文档空间】
|
||||||
|
|
||||||
## 创建文件和文件夹
|
|
||||||
|
|
||||||
使用导航栏左边的文件夹图标可以访问文件资源管理器。您可以通过单击文件资源管理器中的 **创建文件** 图标来创建新文件。您还可以通过单击 **创建文件夹** 图标来创建文件夹。
|
**步骤3**：点击【确认】
|
||||||
|
|
||||||
## 切换到另一个文件
|
|
||||||
|
|
||||||
您的所有文件和文件夹在文件资源管理器中都显示为树。您可以通过单击树中的文件从一个文件切换到另一个文件。
|
**步骤4**：登录睿展的Gitea系统
|
||||||
|
|
||||||
## 重命名文件
|
|
||||||
|
|
||||||
您可以通过单击导航栏中的文件名或单击文件资源管理器中的**重命名**图标来重命名当前文件。
|
**步骤5**：登录成功后，重定向至睿展知识库开始连接文档空间，填写睿展知识库的仓库url【[https://git.rzdata.net/rzdata/knowledge](https://git.rzdata.net/rzdata/knowledge)】后点击【确认】
|
||||||
|
|
||||||
## 搜索文件
|
|
||||||
|
|
||||||
您可以通过单击文件资源管理器中的**搜索文件**图标来通过关键字在整个文档空间中搜索文件。
|
**步骤6**：连接成功后，可发现当前文档空间已切换至睿展知识库，左侧文档目录为睿展知识库的文档目录，点击相应文档可开始文档的编辑维护
|
||||||
|
|
||||||
## 删除一个文件
|
|
||||||
|
|
||||||
您可以通过单击文件资源管理器中的 **删除** 图标来删除当前文件。该文件将被移至 **回收站** 文件夹并在 7 天不活动后自动删除。
|
## 三、文档编辑维护
|
||||||
|
|
||||||
## 导出文件
|
**步骤1**：左侧目录顶部操作按钮可进行文档创建、目录创建、文档或目录的删除、文档或目录的重命名、文档搜索
|
||||||
|
|
||||||
您可以通过单击菜单中的 **导入/导出** 来导出当前文件。您可以选择将文件导出为纯 Markdown、使用 Handlebars 模板的 HTML 或 PDF。
|
|
||||||
|
|
||||||
|
**步骤2**：对文档新增或编辑后，点击【同步】按钮，将文档内容手动同步更新至Gitea仓库（系统会进行定时自动同步，为了保证文档内容的完整，建议文档编辑完成后进行手动同步一次）
|
||||||
# 同步
|
|
||||||
|
|
||||||
同步是 睿展知识库 的最大特点之一。它使您可以将文档空间中的任何文件与存储在**Gitee** 和 **GitHub** 账号中的其他文件同步。这使您可以继续在其他设备上写作，与您共享文件的人协作，轻松集成到您的工作流程中......同步机制在后台每分钟触发一次，下载、合并和上传文件修改。
|
|
||||||
|
手动同步操作也可在文档空间首页点击【同步】按钮进行同步更新
|
||||||
有两种类型的同步，它们可以相互补充：
|
|
||||||
|
|
||||||
- 文档空间同步将自动同步您的所有文件、文件夹和设置。这将允许您在任何其他设备上获取您的文档空间。
|
|
||||||
> 要开始同步您的文档空间，只需在菜单中使用 Gitee 登录。
|
|
||||||
|
|
||||||
- 文件同步将保持文档空间的一个文件与**Gitee**或**GitHub**中的一个或多个文件同步。
|
## 四、文档导入导出
|
||||||
> 在开始同步文件之前，您必须在**同步**子菜单中链接一个账号。
|
|
||||||
|
**步骤1**：在文档空间首位点击【导入/导出】
|
||||||
## 打开一个文件
|
|
||||||
|
|
||||||
您可以通过打开 **同步** 子菜单并单击 **从...打开** 从**Gitee** 或 **GitHub** 打开文件。在文档空间中打开后，文件中的任何修改都将自动同步。
|
|
||||||
|
**步骤2**：支持Markdown与HTML导入，支持Markdown、HTML、PDF导出
|
||||||
## 保存文件
|
|
||||||
|
|
||||||
您可以通过打开 **同步** 子菜单并单击 **在...保存** 将文档空间的任何文件保存到**Gitee** 或 **GitHub**。即使文档空间中的文件已经同步，您也可以将其保存到另一个位置。 睿展知识库 可以将一个文件与多个位置和账号同步。
|
|
||||||
|
## 五、个性化设置
|
||||||
## 同步文件
|
|
||||||
|
### **支持亮暗主题切换与编辑主题切换**
|
||||||
一旦您的文件链接到同步位置，睿展知识库 将通过下载/上传任何修改来定期同步它。如有必要，将执行合并并解决冲突。
|
|
||||||
|
****
|
||||||
如果您刚刚修改了文件并且想要强制同步，请单击导航栏中的 **立即同步** 按钮。
|
|
||||||
|
|
||||||
> **注意：** 如果您没有要同步的文件，**立即同步**按钮将被禁用。
|
|
||||||
|
## 六、补充说明
|
||||||
## 管理文件同步
|
|
||||||
|
目前编辑区对Markdown的可视化操作项并不完整，只有基础的操作项
|
||||||
由于一个文件可以与多个位置同步，您可以通过单击**同步**子菜单中的**文件同步**列出和管理同步位置。这允许您列出和删除链接到您的文件的同步位置。
|
|
||||||
|
|
||||||
|
|
||||||
# 发布
|
编辑器支持标准的Markdown语法，可手动在编辑器中直接进行编辑，或在外部md编辑器编辑好的Markdown文档编辑后进行复制【例如CSDN、Typora】
|
||||||
|
|
||||||
在 睿展知识库 中发布使您可以轻松地在线发布文件。对文件感到满意后，您可以将其发布到不同的托管平台，例如 **Blogger**、**Gitee**、**Gist**、**GitHub**、**WordPress** 和 **Zendesk**。使用 [Handlebars 模板](http://handlebarsjs.com/)，您可以完全控制导出的内容。
|
|
||||||
|
|
||||||
> 在开始发布之前，您必须在**发布**子菜单中链接一个账号。
|
|
||||||
|
|
||||||
## 发布文件
|
|
||||||
|
|
||||||
您可以通过打开 **发布** 子菜单并单击 **发布到** 来发布您的文件。对于某些位置，您可以选择以下格式：
|
|
||||||
|
|
||||||
- Markdown：在可以解释的网站上发布 Markdown 文本（例如**GitHub**），
|
|
||||||
- HTML：通过 Handlebars 模板发布转换为 HTML 的文件（例如在博客上）。
|
|
||||||
|
|
||||||
## 更新发布
|
|
||||||
|
|
||||||
发布后，睿展知识库 会将您的文件链接到该发布，这使您可以轻松地重新发布它。一旦您修改了文件并想要更新您的发布，请单击导航栏中的**立即发布**按钮。
|
|
||||||
|
|
||||||
> **注意：** 如果您没有要同步的文件，**立即同步**按钮将被禁用。
|
|
||||||
|
|
||||||
## 管理文件同步
|
|
||||||
|
|
||||||
由于一个文件可以与多个位置同步，您可以通过单击**同步**子菜单中的**文件同步**列出和管理同步位置。这允许您列出和删除链接到您的文件的同步位置。
|
|
||||||
|
|
||||||
# Markdown扩展
|
|
||||||
|
|
||||||
睿展知识库 通过添加额外的 **Markdown扩展** 扩展了标准 Markdown 语法，为您提供了一些不错的功能。
|
|
||||||
|
|
||||||
> **提示：** 您可以在 **文件属性** 对话框中禁用任何 **Markdown 扩展名**。
|
|
||||||
|
|
||||||
|
|
||||||
## SmartyPants
|
|
||||||
|
|
||||||
SmartyPants 将 ASCII 标点字符转换为“智能”印刷标点 HTML 实体。例如：
|
|
||||||
|
|
||||||
| |ASCII |HTML |
|
|
||||||
|----------------|--------------------------------| ------------------------------|
|
|
||||||
|单反引号|`'这不好玩吗？'` |'这不好玩吗？' |
|
|
||||||
|引用|`“这不好玩吗？”` |“这不好玩吗？” |
|
|
||||||
|破折号 |`-- 是破折号，--- 是破折号`|-- 是破折号，--- 是破折号|
|
|
||||||
|
|
||||||
|
|
||||||
## KaTeX
|
|
||||||
|
|
||||||
您可以使用 [KaTeX](https://khan.github.io/KaTeX/) 渲染 LaTeX 数学表达式：
|
|
||||||
|
|
||||||
满足 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 的 *Gamma 函数* 是通过欧拉积分
|
|
||||||
|
|
||||||
$$
|
|
||||||
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
|
|
||||||
$$
|
|
||||||
|
|
||||||
> 您可以在 [这里](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference) 找到有关 **LaTeX** 数学表达式的更多信息。
|
|
||||||
|
|
||||||
|
|
||||||
## UML 图
|
|
||||||
|
|
||||||
您可以使用 [Mermaid](https://mermaidjs.github.io/) 渲染 UML 图。例如，这将产生一个序列图：
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
sequenceDiagram
|
|
||||||
爱丽丝 ->> 鲍勃: 你好鲍勃，你好吗？
|
|
||||||
鲍勃-->>约翰: 约翰，你呢？
|
|
||||||
鲍勃--x 爱丽丝: 我很好，谢谢！
|
|
||||||
鲍勃-x 约翰: 我很好，谢谢！
|
|
||||||
Note right of 约翰: 鲍勃想了很长<br/>很长的时间，太长了<br/>文本确实<br/>不能放在一行中。
|
|
||||||
|
|
||||||
鲍勃-->爱丽丝: 正在和 John 核对...
|
|
||||||
爱丽丝->约翰: 是的……约翰，你好吗？
|
|
||||||
```
|
|
||||||
|
|
||||||
这将产生一个流程图：
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
graph LR
|
|
||||||
A[长方形] -- 链接文本 --> B((圆形))
|
|
||||||
A --> C(圆角矩形)
|
|
||||||
B --> D{菱形}
|
|
||||||
C --> D
|
|
||||||
```
|
|
||||||
<!--stackedit_data:
|
<!--stackedit_data:
|
||||||
eyJoaXN0b3J5IjpbNDEzMjM3ODQyXX0=
|
eyJoaXN0b3J5IjpbMjA3NDAxNjgxNiw0MTMyMzc4NDJdfQ==
|
||||||
-->
|
-->
|
||||||
Loading…
x
Reference in New Issue
Block a user