跳到正文
我的博客
返回

本站的写作速查

目录

这篇不算正经文章,是把本站支持的写作语法整理成速查表,免得每次写的时候都要翻主题文档。

目录是自动生成的

不需要手写 ## 目录。文章的 h2/h3 标题会自动生成目录:宽屏显示在正文右侧并随滚动高亮,窄屏显示为文章顶部可折叠目录。

提示框

用 GitHub 风格的五种提示框,写在引用块里即可:

Note

普通提示,用来补充一点背景信息。

可以带标题

小技巧或者推荐做法。感叹号后面直接跟标题文字。

Important

重要信息,读者不该错过的那种。

Warning

警告,可能导致数据丢失或者线上故障。

Caution

更严重的警告,操作前请三思。

在 [!TIP] 后面加一个 - 可以让它默认折叠,加 + 则默认展开:

点我展开

折叠起来的内容写在这里。

代码块

普通用法,语言名写在三个反引号后面:

public static double Scale(double raw, double k, double b)
{
    return raw * k + b;
}

高亮某一行,在行尾加 // [!code highlight]:

const scale = (raw: number, k: number, b: number) => raw * k + b; 
const offset = 100;

标注增删,用 // [!code ++] 和 // [!code --]:

const config = {
  site: "https://example.com",
  legacy: true,
};

高亮某个词,用 // [!code word:关键词]:

const timeout = 5000;
console.log(`timeout is ${timeout}ms`);

表格

方案做法代价
重新压缩ffmpeg 降码率画质有损
HLS 切片m3u8 + 分片要配 CORS
换国内存储OSS / COS + CDN要备案和花钱

表格比较宽的时候在手机上会自动变成可横向滚动的块,不会撑破页面。

行内标签

Markdown 里可以直接写 HTML,几个偶尔用得上的:

音频

写一行 <audio> 就行,页面脚本会自动把它升级成主题风格的播放卡片(圆形播放键 + 进度条 + 时间):

标签与归档

文章头部的 tags 会同时生成标签页和聚合入口;pubDatetime 决定排序和归档位置。如果只是改错别字,加 modDatetime 会显示「更新于」而不是换掉发布日期。

草稿

把 draft: true 写进文章头部,这篇文章就不会出现在任何列表里,但本地 npm run dev 仍然能看到。

小结

日常写作其实只用得到标准 Markdown;提示框和代码块增强属于「有更好」的部分。真正要避免的是堆砌语法 —— 语法是给内容服务的。


分享这篇文章:

下一篇
用 Cloudflare R2 托管博客的图片和视频