Markdown 语法是 Flarum 主推的内容输入方案(另外还有 BBCode,下面也会讲到),以下简单介绍 Markdown 的使用方法,本文主要是写给 Flarum 的新手们,帮助小白迅速成为大佬。
标题
标题是每篇文章都需要也是最常用的格式。在 Markdown 中,如果一段文字被定义为标题,只要在这段文字前加 # 号即可。注:“#”和标题之间有一个空格。以此类推,总共六级标题(H1 到 H6,# 号后必须加空格),不过 Flarum 只支持其中的 H1 到 H3,也就是你最多只能打三个“#”号。
text 代码:# 一级标题
text 代码:## 二级标题
text 代码:### 三级标题
列表
熟悉 HTML 的同学肯定知道有序列表与无序列表的区别。在 Markdown 下,列表的显示只需要在文字前加上 - 或 * 即可变为无序列表,有序列表则直接在文字前加 1. 2. 3. 符号要和文字之间加上一个字符的空格。
无序列表
text 代码:- 1
- 2
- 3
有序列表
text 代码:1. a
2. b
3. c
多层序列
text 代码:- 嵌套列表
+ 嵌套列表
+ 嵌套列表
- 嵌套列表
* 嵌套列表
- 嵌套列表
引用
如果你需要引用一小段别处的句子,那么就要用引用的格式。只需要在文本前加入 > 这种尖括号(大于号)即可。
text 代码:> 例如这样
图片与链接
插入链接与插入图片的语法很像,区别在一个 ! 号,中括号为链接文本(图片可以不写),括号为连接地址:
添加链接
text 代码:[Notte 博客](https://www.ikxin.com/)
高级链接
带提示标题的链接
text 代码:[鼠标移上来](https://www.google.com "Google 首页")
引用链接(引用内容不限,可以任意字符,甚至可以写数字)
text 代码:[引用式链接][Notte 博客]
[Notte 博客]: https://www.ikxin.com/
内置链接
text 代码:[内部文件](../blob/master/LICENSE)
添加图片
text 代码:![图片介绍](https://img.8b5.cn/2018/07/26/5b5957facadf4.png)
免费图库推荐 sm.ms
该图库支持生成 Markdown 语法链接。
高级图片
带描述的图片
text 代码:![alt text](https://img.8b5.cn/2018/07/26/5b5957facadf4.png "Logo 文本")
引用式链接
text 代码:![alt text][logo]
[logo]: https://img.8b5.cn/2018/07/26/5b5957facadf4.png "Logo 文本"
粗体、斜体、删除线
Markdown 的粗体和斜体也非常简单,用两个星号包含一段文本就是粗体的语法,用一个星号包含一段文本就是斜体的语法。
text 代码:**这里是粗体**
*这里是斜体*
~~这里是删除线~~
脚注
用于特殊标注,空格作为结束。
text 代码:二月十四号^情人节 这天
代码框
如果你是个程序员,需要在文章里优雅地引用代码框,在 Markdown 下实现也非常简单,只需要用 ` 号
把中间的代码包裹起来。写法分两种:
- 单个或两个
` 号
代表内联文本
分别是 `蔬菜` 和 ``水果``
- 三个
` 号
并回车包裹中间代码,就跟 BBCode 的 code 用法一致了(偷懒的话也可以按四个空格来实现)。
分隔符
在一行中用三个以上的星号 (*)、减号 (-)、下划线 (_) 来建立一个分隔线。
text 代码:***
---
___
提示:如果发现 Markdown 列表代码无效,请于第一行前回车(第一行换行)即可。
附上 Flarum 支持的 BBCode:
- 加粗:
[b]bold[/b]
- 斜体:
[i]italic[/i]
- 下划线:
[u]underline[/u]
- 删除线:
[s]strike[/s]
- 链接:
[url=http://www.xfum.org/]链接[/url]
- 语法高亮:
[code lang=php]<?php phpinfo(); ?>[/code]
- 字体颜色:
[color=red]红色[/color]
或者[color=#ff0000]红色[/color]
- 字体大小:
[size=10]10字号[/size]
- 居中对齐:
[center]居中内容[/center]
- 隐藏内容:
[details=点击查看]隐藏内容[/details]
- 音频:
[audio]https://awk.tw/audio/How.to.pronounce.Vivaldi.mp3[/audio]
- 视频:
[video]https://awk.tw/video/opera_new.mp4[/video]
另外还支持 [img]
、[list]
等,因为 Markdown 已提供更好的实现方案,所以不推荐用 BBCode。
- 列表:
[LIST]
[*]Bullet 1
[*]Bullet 2
[/LIST]
[LIST=1]
[*]Entry 1
[*]Entry 2
[/LIST]
- 高亮内容(dev 0.6.2 新增)
代码:[hl]高亮内容[/hl]