Skip to content

Markdown 语法

FkeMark 支持常见 Markdown 写作语法,并在 Live / Read 模式中把大部分结构渲染成更接近成稿的效果。

基础语法速查

类型写法示例用途
标题# 一级标题组织文章层级
加粗重点强调关键词
斜体术语标记语气或术语
删除线旧内容标记已废弃内容
引用> 引用内容摘录、提示或说明
无序列表- 条目普通列表
有序列表1. 步骤流程步骤
任务列表- [x] 已完成清单和待办
链接标题引用外部或内部资料
图片!说明插入截图或配图
行内代码const name = 'FkeMark'标记变量、命令或短代码

代码块

使用三个波浪线或三个反引号包住代码,并写上语言名称:

md
~~~ts
const mode = 'live'
console.log(mode)
~~~

在编辑器中输入 ```ts 后回车,也可以快速生成代码块。Live 模式会根据语言名称加载语法高亮;如果选择 text 或旧文档中的 plaintext,则作为普通文本显示并保存为无语言围栏。

列表换行

连续列表项建议保持相邻,不必在条目之间额外空一行:

md
- 第一项
- 第二项
- [x] 已完成

如果要结束列表并开始新段落,在整个列表后保留一个空行即可。

表格

md
| 模式 | 适合场景 |
| --- | --- |
| Live | 日常写作 |
| Read | 阅读校对 |
| Source | 精确编辑 |

表格内容较宽时,优先拆短列或拆成多个小表格,阅读体验会更稳定。

Front Matter 和标签

可以在文档开头写 YAML Front Matter,用于记录标题、日期、分类等元信息:

md
---
title: 项目记录
date: 2026-07-23
tags:
  - markdown
  - fkemark
---

正文中也可以使用 #tag 形式保留轻量标签。

脚注

md
这里需要补充说明。[^note]

[^note]: 这是一条脚注内容。

数学公式

行内公式适合短表达式,块级公式适合独立展示:

md
行内公式:$a^2 + b^2 = c^2$

$$
E = mc^2
$$

写作建议

  • 一篇文档建议只保留一个一级标题。
  • 链接文字要有意义,不要只写“点击这里”。
  • 代码块加语言名称,便于高亮和后续检索。
  • 图片建议写清楚替代文本,方便阅读和归档。

Released under AGPL-3.0-only.