Markdown的一些操作小技巧

less than 1 minute read

Published:

1. 使用章节定位符{#HeadingID}

许多Markdown处理器支持标题的自定义ID - 一些Markdown处理器会自动添加它们。添加自定义ID允许您直接链接到标题并使用CSS对其进行修改。要添加自定义标题ID,请在与标题相同的行上用大括号括起该自定义ID。

2. 使用HTML进行图片样式规范{#HtmlPic}

使用 Markdown 插入图片一般有两种方式,Markdown 原生语法 ![]() 和 HTML 的 <img> 标签,但是前者无法定义图片大小和图片解释词,所以最好使用 HTML 进行标定。示例如下:

  • 修改图片大小

      <img src="/images/rocks.jpg" width="200" height="100">
    
  • 为图片添加注释

      <figure style="text-align: center;">
          <img src="/images/20210802/netfilter.png" alt="20210802" width="500" height="150">
          <figcaption>A Netfilter Demo Pic</figcaption>
      </figure>
    

    实际效果如下

    20210802
    A Netfilter Demo Pic

推荐做法

  1. 使用语义化的 HTML 标签
  2. 添加适当的样式增强
  3. 确保内容的可访问性
  4. 保持代码整洁和可维护

避免做法

  1. 过度使用复杂的 HTML
  2. 嵌入不安全的脚本
  3. 忽略移动端适配
  4. 使用已废弃的标签

3. 使用Front Matter{#FrontMatter}

Front Matter 是位于文件顶部、用分隔符包围的元数据区块,用于存储文档的元信息。

很多静态网站生成器都支持 Front Matter:

  • Jekyll (Ruby)
  • Hugo (Go) - 支持 YAML、TOML、JSON 格式
  • Gatsby (React/JavaScript)
  • Next.js (React/JavaScript)
  • Hexo (Node.js)
  • Eleventy (JavaScript)
  • VuePress (Vue.js)
  • GitBook

使用过程中,最佳实践是在分隔符后保持一行空行。</br> 一方面,分行可以从而保持更好的可读性,清晰区分元数据和内容.</br> 但更重要的是,这样可以避免解析问题,例如在 Jekyll 中紧接---的内容会被认为是 Front Matter 的一部分,并引发渲染错误。</br> 最后符合 CommonMark 标准:空行有助于 Markdown 解析器正确识别段落。

4. 使用 Mermaid 绘制示意图{#Mermaid}

5. 开启文章目录{#EnableToc}

6. 同目录内引用{#Callouts}

[[2024-01-30-CKA-Certification.md]]