Quaily 使用GitHub风格的Markdown规范作为撰写文章的基本语法。更多详情请参考GFM规范

有些语法GFM不支持,但Quail支持。列举如下。

📧 邮件兼容性

以下大部分语法目前仅在客户端浏览器中渲染,无法在邮件中显示。

强调

~~删除线~~

==高亮文本==

用 <kbd>Ctrl</kbd> + <kbd>C</kbd> 或者 <kbd>⌘</kbd> + <kbd>C</kbd> 来复制。

删除线

高亮文本

Ctrl + C 或者 + C 来复制。

脚注

Quaily支持PHP Markdown Extra风格的脚注。每个脚注由两部分组成:文本中会变成上标数字的标记[^N],以及将出现在文档底部的脚注本身。

脚注标记可以放在文档的任何位置,但脚注本身总是出现在文档底部。

以下是一个示例:

"好心办坏事"是一句谚语或格言。另一种说法是"地狱充满了善意,天堂却充满了善行"。[^1]

这句谚语的确切起源不明,存在几种变体。
它于1828年以完整形式出现在一份伦敦报纸上,被称为葡萄牙谚语。[^2]
它还发表在Henry G. Bohn 1855年的《谚语手册》中。[^3]

...

[^1]: "通往地狱的路是由好意铺成的",《谚语》,Infobase出版社,2007年,第234页,ISBN 9780816066735
[^2]: "1828年11月2日,1 - 《每周快报》在Newspapers.com"。Newspapers.com。检索于2022-04-11。
[^3]: Bohn, Henry (1855),《谚语手册》

图片

为图片添加说明:

![](https://static.quail.ink/media/qn2u29wq.webp "一个女孩和一个男孩在院子里玩耍")

An image to describe 一个女孩和一个男孩在院子里玩耍 一个女孩和一个男孩在院子里玩耍

为图片指定宽度:

![](https://static.quail.ink/media/qn2u29wq.webp?w=120px)

An image to describe post

嵌入对象

第三方视频链接和对象可以嵌入文章中。目前支持以下视频和对象提供商:

  • YouTube
  • 哔哩哔哩
  • X.com(前身为Twitter)
  • TradingView
  • Quaily 的频道和文章
  • Dify
  • Spotify
  • HTML5 Audio

嵌入对象的语法与图片使用的语法相同:

YouTube & 哔哩哔哩

![](https://youtu.be/dQw4w9WgXcQ?si=0kalBBLQpIXT1Wcd)

![](https://www.bilibili.com/video/BV1uT4y1P7CX)

X.com (前身 Twitter)

![](https://twitter.com/NASA/status/1704954156149084293)

TradingView

![](https://www.tradingview.com/chart/AA0aBB8c/?symbol=BITFINEX%3ABTCUSD)

Quaily 频道和文章

![](https://quaily.com/blog)

![](https://quaily.com/blog/p/quail-weekly-19)

Dify Widget

![](https://udify.app/chatbot/1NaVTsaJ1t54UrNE)

Spotify Embed

![](https://open.spotify.com/track/5vdp5UmvTsnMEMESIF2Ym7)

HTML5 Audio

![](https://cdn1.suno.ai/fc991b95-e4e9-4c8f-87e8-e5e4560755e7.mp3)

Callouts

Github 风格的 callouts 也能很好支持。

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
NOTE

Highlights information that users should take into account, even when skimming.

TIP

Optional information to help a user be more successful.

IMPORTANT

Crucial information necessary for users to succeed.

WARNING

Critical content demanding immediate user attention due to potential risks.

CAUTION

Negative potential consequences of an action.

围栏块(Fenced Divs)

围栏块语法 可用于创建一个样式化的文本块。语法以:::开始,以:::结束。

块的第一行是块的类型和标题,块的其余部分是内容。

预定义的块类型有:infotipimportant, warningdangerinfo

以下是一些例子:

:::info
这是一个信息块,通常用于告知读者一些额外信息。例如:葡萄是一种可以食用的水果。
:::

:::tip
这是一个提示,通常用于告诉读者一些技巧。例如:你可以吃葡萄而不用吐出皮。
:::

:::warning
这是一个警告,通常用于提醒读者。例如:如果你不嚼葡萄,可能会噎住,请注意口中的葡萄。
:::

:::danger
这是一个危险信息,通常用于强调危险操作。例如:被葡萄噎住可能导致死亡,请小心!
:::
INFO

这是一个信息块,通常用于告知读者一些额外信息。例如:葡萄是一种可以食用的水果。

TIP

这是一个提示,通常用于告诉读者一些技巧。例如:你可以吃葡萄而不用吐出皮。

WARNING

这是一个警告,通常用于提醒读者。例如:如果你不嚼葡萄,可能会噎住,请注意口中的葡萄。

DANGER

这是一个危险信息,通常用于强调危险操作。例如:被葡萄噎住可能导致死亡,请小心!

作者还可以为块提供标题:

:::danger 严正声明
葡萄是无辜的,请不要因为吃葡萄可能导致死亡就禁止种植葡萄。
:::
严正声明

葡萄是无辜的,请不要因为吃葡萄可能导致死亡就禁止种植葡萄。

方程式、公式

Quaily 使用MathJax来渲染方程式和公式。这对于撰写科学和工程文章很有用(请在文章选项中启用"启用 MathJax"),例如:

$$
\int f(x)dx \\
\int_1^\infty \frac{1}{x^2}dx
$$

将被渲染为:

\[\int f(x)dx \\ \int_1^\infty \frac{1}{x^2}dx \]

Mermaid图表

Quaily 使用mermaid.js来渲染图表,这也是撰写科学和工程文章的一个很好的工具。

语法如下:

sequenceDiagram
    Alice->>John: 你好John,最近如何?
    John-->>Alice: 很好!
    Alice-)John: 回头见!
```mermaid
sequenceDiagram
    Alice->>John: 你好John,最近如何?
    John-->>Alice: 很好!
    Alice-)John: 回头见!
```