跳转至

文档样例

为统一文档规范,写了这一个文档样例。每个文档标题为一号标题

1 章节标题

每个文档分为几个章节, 章节标题使用二号标题。

1.1 分章节

每个章节可分为一些分章节,分章节标题为三号标题。以此类推。

1.1.1 分章节还可有分章节

标题为四号标题。

1.1.1.1 和分分章节

标题为五号标题。

1.2 章节标号

每一章节,分章节等标题前加上数字标号, 如这一分章节标题前的1.2。

1.3 英文标题

英文标题单词首字母大写,下面是一个例子。

1.3.1 English Title

这是一个英文标题的小章节。

2 字体

2.1 字体颜色

正文用普通字体、黑色。 警告字体用红色。

警告用 红色或者用 红色font>

2.2 强调内容

强调内容可以用*倾斜*-倾斜、**加黑**-加黑、倾斜加黑-倾斜加黑。

3 代码

3.1 行内代码

行内代码由两个反引号括起来,行内代码。 行内代码也可以用来表示强调。

3.2 代码块

代码块可以由两行三个反引号夹起来。 也可以每一行前都加一个tab。

代码折叠

ssh-l[用户名]@lxlogin.ihep.ac.cn#直接在命令行输入该命令,并输入密码
ssh-l[用户名]@lxlogin.ihep.ac.cn#用法与linux相同
#在SSH客户端输入以下命令ssh-l[用户名]@lxlogin.ihep.ac.cn

3.3 引用块

引用可以在每行前加一个>。

>这是引用

这是引用。

可以添加 警告、危险警告等。

示例

  • Note

Note

!!! note重要但非关键的信息提示
  • Abstract

    Abstract

    !!! abstract 标注内容

  • Info

    Info

    !!! info标注内容
  • Tip

    Tip

    !!! tip提高效率的小技巧
  • Success

    Success

    !!! success标注内容
  • Question

    Question

    !!! question标注内容
  • Warning

    Warning

    !!! warning可能导致问题的操作提醒
  • Failure

    Failure

    !!! failure标注内容
  • Danger

    Danger

    !!! danger会导致数据丢失或系统故障的操作

4 列表

有序列表用来表示步骤等,无序列表用来表示枚举等。

4.1 有序列表

把大象装进冰箱分几步:

  1. 把冰箱门打开

  2. 把大象塞进去

  3. 把冰箱门关上

4.2 无序列表

无序列表有两种表示方式。

4.2.1 无序列表 1

一种是用-表示。 下面的都是水果

  • 苹果
  • 橘子
  • 香蕉

4.2.2 无序列表 2

一种是用*表示。 下面的都动物

  • 猫

  • 狗

  • 鸡

  • 鸭

6 中英文版本

6.1 中英互换

文档顶部有中文|English链接。点击后会中英版本互换。

6.2 图片复用

英文版本在相同目录下以en.md为后缀,图片可以通过相对路径方式进行复用。

这是中文版本下的一个图片![chinese](./chinese.png)这是英文版本下的一个图片![english](./english.png)

AI 助手
快速提问 ×

有问题?输入后跳转到对话页继续交流

Baidu
map