← 返回

夜航手记

LianMarkup 语法一览

博客的母语 LianMarkup:一篇用 .ly 写成的语法漫游

目录 · 17 节LianMarkup 语法一览标题目录指令文本样式链接与图片列表引用与分割线注释Callout 家族折叠块分栏块旁注代码块原样块行内容器小玩具表格

LianMarkup 语法一览

这个博客的文章使用 LianMarkup1 书写。本页是全部语法的实际渲染演示 —— 每个格子都是分栏块: 左边是写法, 右边是效果。

标题

## 二级标题 {#custom-id}

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • # 后必须有空格, 否则视为正文
  • 标题自动获得 h-N 锚点2, 用 {#custom-id} 可覆盖
  • 二级标题在夜航主题里会带 01/02 序号角标3, 上面这几级演示标题在分栏块里, 所以你看不到角标

目录指令

@toc depth=2

@ 开头的是指令: 不产生正文, 只影响文档结构。@toc 让编译器收集所有标题生成目录树, depth 控制收集层级 —— 本页左侧 (移动端在顶部) 的目录, 就来自文章开头这一行。

文本样式

**加粗** *斜体* ***粗斜体*** ~~删除线~~ ==高亮== `行内代码`

加粗 斜体 粗斜体 删除线 高亮 行内代码

不配对的符号自动回退为文本4, 不需要转义。需要字面量时用 ``:

2*3=6 不是斜体, \*\*这不是加粗\*\*

2*3=6 不是斜体, **这不是加粗**

链接与图片

[链接文字](https://github.com/Yueosa/LianMarkup)
![竖图示例](https://picsum.photos/400/600){width=40% group=demo}

图片支持可选属性: width 控制宽度 (竖图友好), group 相同的图片在灯箱里归为一组。

列表

嵌套统一用 TAB5, 每层一个:

- 无序项
	- TAB 缩进嵌套
* 星号项 (另一种样式)
1. 有序项
- [ ] 待办
* [x] 已完成
  • 无序项
    • TAB 缩进嵌套
  • 星号项 (另一种样式)
  1. 有序项
  • 待办
  • 已完成

引用与分割线

> 引用块, 空行结束。

---

引用块, 空行结束。


轻分割 --- 是段落间的呼吸; 重分割 ___ 是幕间转换线, 用在"换个世界"的时刻:

上一幕的结尾。

___

下一幕的开头。

上一幕的结尾。


下一幕的开头。

注释

// 这行只存在于源码里, 不会渲染。
这行能看到。

这行能看到。

写了一半的段落、给自己的 TODO, 都可以安心留在源码里。

Callout 家族

五种6, 首行是标题, 空行结束:

>? 疑问块 `>?`
>存放一个问题, 以及它的展开讨论。

疑问块 >?

存放一个问题, 以及它的展开讨论。

>! 警告块 `>!`
>必须避开的坑, 红色醒目。

警告块 >!

必须避开的坑, 红色醒目。

>+ 技巧块 `>+`
>可以偷懒的小技巧。

技巧块 >+

可以偷懒的小技巧。

>x 反例块 `>x`
>不要这样做的示范。

反例块 >x

不要这样做的示范。

>i 信息块 `>i`
>中性的补充说明。

信息块 >i

中性的补充说明。

折叠块

两种写法7: TAB 缩进作用域, 或 <<< 显式配对。>>>+ 默认展开:

>>> 点我展开 (缩进模式)
	这行属于折叠块。
	缩进回退即结束。
点我展开 (缩进模式)

这行属于折叠块。 缩进回退即结束。

>>>+ 我默认展开 (配对模式)
用 <<< 结束。
<<<
我默认展开 (配对模式)

用 <<< 结束。

分栏块

||| 围栏 + === 分栏, 段数即栏数8。栏内是任意块级语法, 唯一限制是不能嵌套(围栏相同, 内外层无从区分)。

|||
左栏

===
右栏
|||

上面这段源码的效果:

左栏

右栏

旁注

正文里的上标[^就是这样, 备注内容就地书写]是旁注。

正文里的上标9是旁注。

桌面端显示在正文右侧, 移动端点上标展开。旁注内容支持全部行内语法 (比如 链接), 但不能嵌套旁注。

代码块

```rust
fn main() {
    println!("你好, LianMarkup!");
}
```
fn main() {
    println!("你好, LianMarkup!");
}

mermaid 语言标记会原样透传给前端渲染图表, diff 由集成层渲染增删行10:

```mermaid
flowchart LR
    A[作者] -->|写 .ly| B[解析器]
    B -->|输出| C[HTML + TOC + 旁注]
```
flowchart LR
    A[作者] -->|写 .ly| B[解析器]
    B -->|输出| C[HTML + TOC + 旁注]
```diff
- 光图形壳就吃 1GB 内存
+ 核心内存占用不超 64MB
```
- 光图形壳就吃 1GB 内存+ 核心内存占用不超 64MB

原样块

三个波浪号包裹的内容零解析:

~~~ 这里面 **不会加粗**, # 也不是标题 ~~~

这里面 **不会加粗**, # 也不是标题

行内容器

[文字]{.类名} 给文字挂上 CSS 类11, 抖动、渐变、变色等效果全由 CSS 定义, 文章只声明参数:

[这段文字会抖动]{.shake}

[渐变色的文字]{.gradient from=#ff6b6b to=#4ecdc4}

这段文字会抖动

渐变色的文字

小玩具

凶手其实是||管家|| (点击显示)

凶手其实是管家 (点击显示)

质能方程 $E=mc^2$

质能方程 $E=mc^2$

$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$
$$ \int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi} $$
{漢字|かんじ} 和 {汉字|hàn zì}

漢字かんじ 和 汉字hàn zì

表格

| 语法 | 用途 |
|-|-|
| `@toc` | 目录指令 |
| `[^...]` | 旁注 |
| `>>>` | 折叠块 |
| `|||` + `===` | 分栏块 |
语法用途
@toc目录指令
[^...]旁注
>>>折叠块
||| + ===分栏块

完整定义见 语法规范, 一页速查见 语法速查。

评论

0 条

评论会在审核后显示;昵称和邮箱会公开展示。

暂时还没有评论。

订阅更新