跳转至

Markdown语法指南

◀返回贡献指南

Markdown是一种使用纯文本格式编写,通过适当的编译,能够显示出丰富特征的标记语言。以下是一些常用的Markdown语法:

Markdown 简单说明

加粗
斜体

标题一

标题二

标题三

标题四

标题五
标题六

代码块

多行代码块   

链接 https://freeodwiki.org <https://freeodwiki.org>

引用

\(支持内嵌\TeX\)

支持内嵌HTML

  • 无序列表

  • 有序列表

代码块:把你想要的文字夹在`中间

插入图片 ”)
FreeODwiki.png

超链接 文本”)
freeodwiki.org

相对路径,以index.md为例:(index.md)

相对路径,进入上一层目录(无法在CONTRIBUTING.md中举例): (../index.md) 该语法可叠加,可以返回多层目录以前

上标 <sup>上标</sup>

下标 <sub>下标</sub>

删除线 <s>删除线</s>

一条线 ---


如果你不要这个标题二效果上行留空

引用 > 引用

展开框文本 展开框内部。注:若要在展开框内部使用Markdown语法,需要将`
`换成 `
`,否则某些阅读器不会渲染Markdown语法
<details>  <summary> 展开框文本 </summary>

展开框内部。注:若要在展开框内部使用Markdown语法,需要将`<details>`换成 `<details markdown="1">`

</details>
脚注[^1] `[^1]` (某些阅读器中无效) [^1]: 在下方使用`[^1]: 脚注内容` ### 不推荐使用的语法 由于本仓库涉及多个平台,因此不推荐使用仅特定Markdown渲染器可用的语法,或在不同Markdown渲染器中存在歧义的语法。 以下是一些不建议使用的语法,并给出推荐的替代方案: - ^上标^ `^上标^` 推荐替代方案:上标 `上标` - ~下标~ `~下标~` 推荐替代方案:下标 `下标` - ~删除线~ `~删除线~` 推荐替代方案:删除线 `删除线` - Wiki.js 资讯引用 {.is-info} - Wiki.js 成功引用 {.is-success} - Wiki.js 警告引用 {.is-warning} - Wiki.js 错误引用 {.is-danger} ## 复制一般文本到Markdown的注意事项 + 请注意文本中的某些元素是否意外构成Markdown语法,导致显示错误的问题。例如:
我昨天只睡了4个小时前天更是只睡了3个小时
会渲染为: --- 我昨天只睡了4个小时前天更是只睡了3个小时 --- 这是错误的,正确的写法是使用转义字符`\`:
我昨天只睡了4个小时\前天更是只睡了3个小时\
会渲染为: --- 我昨天只睡了4个小时\前天更是只睡了3个小时\ --- + 请注意在Markdown中换行不会直接换行。例如:
昨天,他只睡了4个小时
前天更是只睡了3个小时
意外猝死正在悄然酝酿
会渲染为: --- 昨天,他只睡了4个小时 前天更是只睡了3个小时 意外猝死正在悄然酝酿 --- 这是错误的,正确的写法是(请注意在结尾添加的两个空格):
昨天,他只睡了4个小时  
前天更是只睡了3个小时  
意外猝死正在悄然酝酿  
会渲染为: --- 昨天,他只睡了4个小时 前天更是只睡了3个小时 意外猝死正在悄然酝酿 --- > 上一个版本中这里写的是使用`
`,这里简要说明一下为什么更改。第一,很明显两个空格看上去很明显要简洁不少也少打一点字。第二,`
`并不是一个标准的Markdown语法他是Markdown内嵌HTML,因此并不是所有Markdown解释器都支持这一点,也就是不好的编程习惯了,本PR的提交者在自己的网站中就使用的是两个空格,不过我相信可能有些人会觉得显式优于~~隐形~~隐式因此保留了这一段。 {.is-info} 要分段请使用Markdown的方式——添加一个空行 这些错误可以通过预览文件避免,等到你做过这些事情,知道要避免踩坑的注意事项了,也就不会犯这些错误了,加油哦! ## 另见 - [渲染测试](/个人文件夹/Cbscfe/渲染测试.html)