当前位置：首页 > news >正文

sward入门到实战(4) - 如何编写Markdown文档

news 2025/9/23 8:03:46

sward是一款国产开源免费的知识管理工具，包含知识库管理、文档管理、markdown管理、文档协作、文档分享等功能，工具轻量、简洁易用。其中markdown，非常适合技术文档编写、博客创作、笔记整理等场景，本文主要介绍markdown的添加与管理。

1、添加Markdown

位置	路径	描述
知识库概况	知识库->知识库概况->添加	此处添加的Markdown，会显示在树形结构的第一层
文档页面的“+”号	知识库->文档->"+"按钮	此处添加的Markdown，会显示在树形结构的第一层
目录树的更多	知识库->文档->目录后的“+”按钮	此处添加的markdown会显示在目录下方

点击添加->添加markdown，系统会创建出一个名字为“未命名文档”的markdown。文档分为左右两个部分

markdown初创建

添加内容后，可以点击保存->退出，内容保存成功

也可以退出或切换到其他文档，系统会自动保存

格式	方法
标题	点击“H”，选择标题大小，页面会出现#号标识，一个#代表一号标题，依此类推
正文	点击“H”，选择正文，页面会出现P标识，在P后面填写的内容会以正文的方式出现
斜体	点击“Ⅰ”，页面出现**，在两个星号之间填写内容，内容会在展示区域以斜体样式显示
删除线	点击“S”，页面出现~~~~，在四个波浪线中间填写内容，展示区域会以删除线的方式展示，如：~~删除~~

基础文本格式

格式	方法
无序列表	点击“无序列表”，页面出现“-”，在此符号后面填写内容，展示区域会以无序列表的形式展示
有序列表	点击“有序列表”，页面出现“1.”，在此符号后面填写内容，展示区域会以有序列表的形式展示
任务列表	点击任务列表□和☑，分别出现“- [ ] ”和“- [x ] ”,在此符号后面填写内容，展示区域会以未选中、选中显示
分割线	点击“~~分割线~~”，页面出现---，展示区域会同步显示一条长分割线

列表

格式	方法
引用	点击“引用”，页面出现“> ”，在此符号后面填写内容，展示区域会以特殊样式展示
代码行	点击“代码行”，页面出现“``”，在两点中间填写内容，会将内容用代码的样式展示，用来标记一小段行内代码
代码块	点击“代码块”，页面出现一对3个反引号，在反引号中间填写内容，会将内容以代码形式展示。标注代码语言，可以根据代码语法进行高亮

代码与引用

格式	方法
附件	点击“附件”，页面出现“[link](url) ”，link为展示的链接名称，url为跳转的链接地址。如：link为百度，url为http:www.baidu.com
表格	点击“表格”，页面出现表格样式
图标	点击“图片”，页面出现“![link](url)”，link是图片img标签的alt属性内容，url为图片的地址。