跳转至

演示页面 #

本页面展示了在编写文档时可用的样式指南。请尽情使用！

二级标题#

三级标题#

四级标题#

加粗文本

斜体文本

高亮文本

下划线文本

删除线文本

行内代码

# 带语法高亮的行内代码

def test()

图标（例如 、 和 ）与表情符号（例如 😄、😙 和 🥲）可在此搜索

图片标题

带说明文字的图片

  • 已完成事项
  • 未完成事项
  • 子事项 #1
  • 子事项 #2
  • 子事项 #3

  • 拉丁占位文本（测试长文本换行）

  • 无序列表项

  1. 有序列表项
# Python 代码块（带语法高亮）
import os
hello.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Block code text with a title and line numbers and highlighted lines
import rclpy
from rclpy.node import Node
import rclpy.time
from control_msgs.msg import DynamicJointState, JointJog
from geometry_msgs.msg import TwistStamped, PoseStamped
from tf2_msgs.msg import TFMessage
from airbot_msgs.msg import StateMsg
from airbot_msgs.srv import ControlModeSwitch
from moveit_msgs.srv import ServoCommandType, GetMotionSequence
from tf2_ros import Buffer, TransformListener
from typing import Optional, List
import threading
from bidict import bidict

脚注引用示例^1

带图标的表格：

| 方法 | 描述 | | ---------- | --------------------------- | | GET | 获取资源 | | PUT | 更新资源 | | DELETE | 删除资源 |

流程图语法详见此处

graph LR
  A[开始] --> B{有错误?};
  B -->|是| C[调试...];
  C --> D[修复];
  D --> B;
  B ---->|否| E[完成!];

序列图语法详见此处

sequenceDiagram
  autonumber
  张三->>李四: 你好，最近怎么样?
  loop 健康检查
      李四->>李四: 与焦虑对抗
  end
  Note right of 李四: 理性思考!
  李四-->>张三: 很好!
  李四->>王五: 你那边呢?
  王五-->>李四: 一切正常!

ER 图语法详见此处

erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER ||--|{ LINE-ITEM : contains
  LINE-ITEM {
    string name
    int pricePerUnit
  }
  CUSTOMER }|..|{ DELIVERY-ADDRESS : uses

线框按钮{ .md-button }

填充按钮{ .md-button .md-button--primary }

Note

这是一个标准提示框

A note with a title

"带标题的提示框" 这是带自定义标题的提示框

这是没有标题的提示框

Note

默认折叠的提示框（点击展开）

Note

默认展开的提示框（点击折叠）

Abstract

摘要型提示框

Tip

技巧型提示框

Info

信息型提示框

Success

成功状态提示框

Warning

警告型提示框

Failure

失败状态提示框

Danger

危险警告提示框

Bug

缺陷说明提示框

Example

示例说明提示框

Quote

引用型提示框