Skip to content

写作注意事项

前言

在使用 Elog 同步语雀上的文档时,因为是将富文本向下转成 markdown,会有很多样式损失。这是由于 markdown 样式集合< 语雀样式集合。所以在语雀上书写时,得按照 markdown 支持的样式进行写作。

可以在这里看到语雀文档被导出为 markdown 时的样式损失程度

如果你不能接受样式损失,可能 markdown 并不适合你,隔壁 NotionNext 可能更适合你搭建文档站点。

语雀格式注意点

不要使用 markdown 不支持的样式/语法

例如字体颜色、多级折叠块、分栏、数据表、嵌入等。导出为 markdown 都不能正常展示。

使用双换行符或结尾双空格进行段落换行

根据 markdown 的写作建议,可以使用双换行符或结尾双空格进行段落换行,而语雀导出的 markdown 不会使用此方式,所以会导致段落换行失败。这里就使用了结尾双空格换行
所以在语雀书写文档时,就需要使用此方法进行段落换行。

语雀一级标题留给文档标题(建议)

VitePress 的正文缺少文档标题可能会比较别扭,所以这里建议语雀一级标题留给文档标题,正文从二级标题开始写作

部分高亮块在 VitePress 可能不支持显示

参考这里的示例,使用受支持的高亮块,VitePress 紫色 tip 高亮块的语法是 ::: tip ,而语雀灰色背景(第一个)的高亮块解析出来为 ::: tips
所以如果想要使用VitePress 紫色 tip 高亮块,可直接在语雀文档手动使用文本格式的::: tip,例如

TIP

VitePress 紫色 tip 高亮块,此高亮块为语雀文档手写的 ::: tip

TIP

2023/11/20更新:模版仓库已添加自定义文档适配器,已经将所有 tips 文本替换为 tip, 此高亮块为语雀灰色高亮块

TIP

仿照此示例,你也可以同样将::: success替换为::: tip等 VitePress 支持的格式 此高亮块就是语雀绿色高亮块