kuGadgets
KuGadgets
docs_back_to_center

Markdown 格式指南

学习如何在 KuGadgets 文档中使用 Markdown 格式

3 docs_minutes_read514 docs_words
2024年1月15日
KuGadgets Team
教程
Markdown
格式
写作
帮助文档
教程

Markdown 格式指南

本指南将帮助您掌握在 KuGadgets 文档中使用 Markdown 格式的技巧。

基础语法

标题

Markdown 支持六级标题，使用 # 符号表示：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

文本格式

您可以使用以下语法来格式化文本：

  • 粗体文本 - 使用 **粗体** 或 __粗体__
  • 斜体文本 - 使用 *斜体* 或 _斜体_
  • 粗斜体 - 使用 ***粗斜体***
  • 删除线 - 使用 ~~删除线~~
  • 行内代码 - 使用反引号包围

段落和换行

段落之间用空行分隔。如果需要在段落内换行，在行末添加两个空格。

这是第一段文字。

这是第二段文字，
这里有一个换行。

列表

无序列表

使用 -、+ 或 * 创建无序列表：

  • 第一项
  • 第二项
    • 嵌套项目
    • 另一个嵌套项目
  • 第三项

有序列表

使用数字和点创建有序列表：

  1. 第一步
  2. 第二步
    1. 子步骤 A
    2. 子步骤 B
  3. 第三步

任务列表

创建可勾选的任务列表：

  • 已完成的任务
  • 待完成的任务
  • 另一个待完成的任务

链接和图片

链接

创建链接的语法：

图片

插入图片的语法：

KuGadgets Logo

代码

行内代码

使用反引号包围行内代码：console.log('Hello World')

代码块

使用三个反引号创建代码块：

function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet('KuGadgets');

def calculate_area(radius):
    """计算圆的面积"""
    import math
    return math.pi * radius ** 2

area = calculate_area(5)
print(f"圆的面积是: {area:.2f}")

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本
npm run build

表格

创建表格使用管道符 | 分隔列：

功能 免费版 Pro版
基础工具 ✅ ✅
AI功能 限制使用 无限使用
优先队列 ❌ ✅
API访问 ❌ ✅

对齐方式：

左对齐 居中对齐 右对齐
内容1 内容2 内容3
较长的内容 中等内容 短内容

引用

使用 > 创建引用块：

这是一个引用块。

引用可以包含多个段落，以及其他 Markdown 元素。

这是嵌套引用。

分隔线

使用三个或更多的连字符、星号或下划线创建分隔线：

高级功能

脚注

您可以添加脚注1来提供额外信息。

定义列表

术语1 : 这是术语1的定义。

术语2 : 这是术语2的定义。 : 一个术语可以有多个定义。

键盘按键

使用 <kbd> 标签表示键盘按键：

按 Ctrl + C 复制文本。

高亮文本

使用 == 包围文本来高亮：

这是 ==高亮文本== 的示例。

数学公式

行内公式

使用单个 $ 包围行内公式：$E = mc^2$

块级公式

使用双 $$ 创建块级公式：

$$ \int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi} $$

图表

Mermaid 流程图

graph TD
    A[开始] --> B{是否登录?}
    B -->|是| C[显示工具列表]
    B -->|否| D[跳转到登录页]
    D --> E[用户登录]
    E --> C
    C --> F[选择工具]
    F --> G[使用工具]
    G --> H[结束]

时序图

sequenceDiagram
    participant U as 用户
    participant F as 前端
    participant A as API
    participant D as 数据库
    
    U->>F: 上传文件
    F->>A: 发送处理请求
    A->>D: 保存文件信息
    D-->>A: 返回文件ID
    A->>A: 处理文件
    A-->>F: 返回处理结果
    F-->>U: 显示结果

最佳实践

1. 标题层次

保持标题的层次结构清晰：

# 文档标题 (H1)
## 主要章节 (H2)
### 子章节 (H3)
#### 详细说明 (H4)

2. 代码示例

为代码块指定语言以获得语法高亮：

```javascript
// 好的做法
const result = processData(input);

// 不好的做法 - 没有指定语言
const result = processData(input);


### 3. 链接管理

对于经常使用的链接，使用引用式链接：

```markdown
查看 [KuGadgets 官网][kugadgets] 了解更多信息。

[kugadgets]: https://kugadgets.com "KuGadgets 官方网站"

4. 图片优化

  • 使用描述性的 alt 文本
  • 控制图片大小
  • 使用适当的格式（PNG、JPG、WebP）

常见问题

Q: 如何在表格中使用管道符？

A: 使用反斜杠转义：\|

Q: 如何创建空行？

A: 使用 &nbsp; 或者两个空格加换行。

Q: 支持 HTML 标签吗？

A: 是的，Markdown 支持大部分 HTML 标签，但建议优先使用 Markdown 语法。

总结

掌握 Markdown 语法可以帮助您：

  1. 快速创建 格式化文档
  2. 专注内容 而不是格式
  3. 跨平台兼容 在任何支持 Markdown 的平台使用
  4. 版本控制友好 纯文本格式便于追踪变更

开始使用这些技巧来创建更好的文档吧！如果您有任何问题，请查看我们的 FAQ 或 联系支持团队。

Footnotes

  1. 这是脚注的内容。 ↩

docs_next_article
常见问题