Markdown syntax is Flarum's primary content input method (BBCode is another option, which will also be covered below). The following is a brief introduction to using Markdown. This article is mainly written for Flarum beginners, helping newcomers quickly become experts.
Headings
Headings are a format needed in and commonly used by every article. In Markdown, if a line of text is defined as a heading, simply add a # symbol before it. Note: There is a space between “#” and the heading text. There are six heading levels in total (H1 to H6; a space must be added after the # symbol). However, Flarum supports only H1 to H3, meaning you can use at most three “#” symbols.
# 一级标题
## 二级标题
### 三级标题
Lists
Those familiar with HTML surely know the difference between ordered and unordered lists. In Markdown, to create an unordered list, simply add - or * before the text. For an ordered list, add 1. 2. 3. directly before the text, with a space between the symbol and the text.
Unordered list
- 1
- 2
- 3
Ordered list
1. a
2. b
3. c
Nested list
- 嵌套列表
+ 嵌套列表
+ 嵌套列表
- 嵌套列表
* 嵌套列表
- 嵌套列表
Blockquotes
If you need to quote a short passage from elsewhere, use the blockquote format. Simply add the > angle bracket (greater-than sign) before the text.
> 例如这样
Images and Links
The syntax for inserting links and images is very similar; the difference is the ! symbol. The square brackets contain the link text (which can be omitted for images), and the parentheses contain the link address:
Adding links
[Notte 博客](https://www.ikxin.com/)
Advanced links
Links with a tooltip title
[鼠标移上来](https://www.google.com "Google 首页")
Reference links (the reference content can be anything, including arbitrary characters or even numbers)
[引用式链接][Notte 博客]
[Notte 博客]: https://www.ikxin.com/
Internal links
[内部文件](../blob/master/LICENSE)
Adding images
Free image hosting recommendation: sm.ms
This image host supports generating Markdown syntax links.
Advanced images
Images with descriptions
Reference-style links
![alt text][logo]
[logo]: https://img.8b5.cn/2018/07/26/5b5957facadf4.png "Logo 文本"
Bold, Italics, and Strikethrough
Bold and italics in Markdown are also very simple: enclosing a section of text with two asterisks creates bold text, while enclosing it with one asterisk creates italic text.
**这里是粗体**
*这里是斜体*
~~这里是删除线~~
Footnotes
Used for special annotations; a space marks the end.
二月十四号^情人节 这天
Code Blocks
If you are a programmer and need to elegantly quote code in an article, Markdown makes this very simple as well. You only need to use `` symbols ` to wrap the code in between. There are two ways to write it:
- A single or two `` symbols ` represent inline text
分别是 `蔬菜` 和 ``水果``
- Three `` symbols ` followed by a line break wrap the code in between, which is consistent with the usage of BBCode's code tag (if you want to take a shortcut, you can also use four spaces).
Separators
Use three or more asterisks (*), hyphens (-), or underscores (_) on a line to create a separator.
***
---
___
Tip: If Markdown list code does not work, press Enter before the first line (add a line break at the beginning).
Here is the BBCode supported by Flarum:
- Bold:
[b]bold[/b] - Italics:
[i]italic[/i] - Underline:
[u]underline[/u] - Strikethrough:
[s]strike[/s] - Link:
[url=http://www.xfum.org/]链接[/url] - Syntax highlighting:
[code lang=php]<?php phpinfo(); ?>[/code] - Font color:
[color=red]红色[/color]or[color=#ff0000]红色[/color] - Font size:
[size=10]10字号[/size] - Center alignment:
[center]居中内容[/center] - Hidden content:
[details=点击查看]隐藏内容[/details] - Audio:
[audio]https://awk.tw/audio/How.to.pronounce.Vivaldi.mp3[/audio] - Video:
[video]https://awk.tw/video/opera_new.mp4[/video]
It also supports [img], [list], and others. Since Markdown already provides better implementations, using BBCode is not recommended.
- Lists:
[LIST]
[*]Bullet 1
[*]Bullet 2
[/LIST]
[LIST=1]
[*]Entry 1
[*]Entry 2
[/LIST]
- Highlighted content (added in dev 0.6.2)
Code: [hl]高亮内容[/hl]