Markdown 扩展
FluxPress 在标准 Markdown 的基础上,通过一系列 markdown-it 插件提供了丰富的写作扩展语法。
TIP
以下扩展语法依赖主题支持,当前由官方 classic 主题内置实现。
代码高亮
FluxPress 使用 highlight.js 提供语法高亮,支持行内代码和代码块。
代码块:
markdown
```javascript
const greeting = 'Hello, FluxPress!'
console.log(greeting)
```行内代码高亮:
markdown
使用 `const` 声明变量。任务列表
支持 GitHub 风格的任务列表语法。
输入:
markdown
- [x] 已完成的任务
- [ ] 未完成的任务
- [x] 另一个已完成的任务输出:
- [x] 已完成的任务
- [ ] 未完成的任务
- [x] 另一个已完成的任务
脚注
在文章中添加脚注说明。
输入:
markdown
这里有一个脚注[^1],还有另一个[^2]。
[^1]: 第一个脚注的内容。
[^2]: 第二个脚注的内容,可以包含更多文字。输出效果: 脚注会在文章底部自动收集和渲染,并生成返回链接。
可折叠块
使用可折叠块(collapsible)组织可展开/收起的内容。
输入:
markdown
+++ 点击展开查看详情
这里是折叠的内容,默认不显示。
可以包含多行文字、代码块等内容。
+++说明:
+++后面跟着摘要(折叠时显示的文字)- 摘要和第二个
+++之间是折叠的内容 - 点击摘要可以展开/收起内容
标题锚点
所有标题会自动生成锚点 ID,可以直接链接到文章中的特定位置。
输入:
markdown
## 我的标题生成的 HTML:
html
<h2 id="我的标题"><a href="#我的标题">我的标题</a></h2>在其他地方可以通过 #我的标题 直接跳转到该位置。
目录
使用 [[toc]] 在文章任意位置插入目录,目录会根据文章中的标题自动生成。
输入:
markdown
[[toc]]
## 第一章
## 第二章
### 第二章第一节输出效果: 自动生成带链接的多级目录列表。
标准 Markdown
以上扩展均在标准 Markdown 语法的基础上叠加,所有 Markdown 基础语法均可正常使用,包括:
- 标题(
#、##、###…) - 加粗(
**text**)、斜体(*text*)、删除线(~~text~~) - 链接(
[text](url))、图片() - 有序列表、无序列表
- 引用块(
>) - 水平分割线(
---) - 表格
由于文章内容来自 GitHub Issues,GitHub 编辑器本身也支持这些语法,写作体验与在 GitHub 上编写 Issue 一致。
