跳转至

◀返回贡献指南

Markdown语法指南

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

Markdown & Wiki.js 简单说明

加粗
斜体
删除线

标题一

标题二

标题三

标题四

标题五
标题六
  • 无序列表
  • 有序列表

代码块

多行代码块

插入图片 ”)
FreeODwiki.png

超链接 文本”)
freeod.wiki

链接 https://freeod.wiki

上标
下标

一条线

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

引用

(不建议使用wiki.js的语法)

Wiki.js 资讯引用

Wiki.js 成功引用

Wiki.js 警告引用

Wiki.js 错误引用

$支持内嵌\TeX$

支持内嵌HTML

**加粗**  
*斜体*  
~~删除线~~  

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

- 无序列表
1. 有序列表

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


插入图片 `”)`  
![FreeODwiki.png](/FreeODwiki.png)

超链接 `文本”)`  
[freeod.wiki](https://freeod.wiki/)  

相对路径,以home.md为例:`(./home.md)`

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

链接 <https://freeod.wiki>  

^上标^  
~下标~  

一条线
---
如果你不要这个标题二效果上行留空

> 引用

> Wiki.js 资讯引用
{.is-info}

> Wiki.js 成功引用
{.is-success}

> Wiki.js 警告引用
{.is-warning}

> Wiki.js 错误引用
{.is-danger}

$支持内嵌\TeX$
<p style="color:#456789">支持内嵌HTML</p>

复制一般文本到Markdown的注意事项

  • 请注意文本中的某些元素是否意外构成Markdown语法,导致显示错误的问题。例如:
    我昨天只睡了4个小时前天更是只睡了3个小时
    
    会渲染为:

我昨天只睡了4个小时前天更是只睡了3个小时


这是错误的,正确的写法是使用转义字符\

我昨天只睡了4个小时\前天更是只睡了3个小时\
会渲染为:


我昨天只睡了4个小时\前天更是只睡了3个小时\


  • 请注意在Markdown中换行不会直接换行。例如:
    昨天,他只睡了4个小时
    前天更是只睡了3个小时
    意外猝死正在悄然酝酿
    
    会渲染为:

昨天,他只睡了4个小时 前天更是只睡了3个小时 意外猝死正在悄然酝酿


这是错误的,正确的写法是(请注意在结尾添加的两个空格):

昨天,他只睡了4个小时  
前天更是只睡了3个小时  
意外猝死正在悄然酝酿  
会渲染为:


昨天,他只睡了4个小时
前天更是只睡了3个小时
意外猝死正在悄然酝酿


上一个版本中这里写的是使用<br>,这里简要说明一下为什么更改。第一,很明显两个空格看上去很明显要简洁不少也少打一点字。第二,<br>并不是一个标准的Markdown语法他是Markdown内嵌HTML,因此并不是所有Markdown解释器都支持这一点,也就是不好的编程习惯了,本PR的提交者在自己的网站中就使用的是两个空格,不过我相信可能有些人会觉得显式优于~隐形~隐式因此保留了这一段。

要分段请使用Markdown的方式——添加一个空行

这些错误可以通过预览文件避免,等到你做过这些事情,知道要避免踩坑的注意事项了,也就不会犯这些错误了,加油哦!