学习笔记

markdown 语法简介

#markdown #知识管理 #文档写作 #格式教程

1. 简介

markdown 是一种轻量化的语言,类似于 html,但比 html 简单很多,相较于 word,无法做到可见即所得,需要通过特定的编辑起来预览。

现在主流的知识平台都支持 markdown 文档(以下简称 md 文档)。最主要的是在 ai 时代,md 文档可以让 ai 更好的理解你的文档,来构建你的个人数据库。这也是我使用 md 文档的主要原因。

2. 语法

这里我将只参照 word 的语法进行介绍,了解以下这些,写上一两篇文章就可以熟悉了。备注一下,这是我用 md 写的第一篇文章。

除出现在正文的标记符号后面都要加空格,例如标题标记#,列表标记’-‘和 1. 除出现在正文的标记符号一般都是放在首位

  • 标题 使用#来表示,#越多,标题越小,类似于 1 级标题到 6 级标题

    示例: #【空格】一级标题 ##【空格】二级标题 ###【空格】 三级标题 …

    一级标题

    二级标题

    三级标题


  • 段落 分割线---


空行
(不要空格)

  • 列表 列表分为有序列表和无序列表,使用 - 和 数字 1.
    多级列表在第二行使用 Tab 键,后加标记符号

    示例: -【空格】无序列表 Tab-【空格】多级列表 2.【空格】有序列列表

    • 无序列表
      • 多级列表
    1. 有序列表
  • 文字 文字的标记符号不用考虑是否在行首,或者加空格,两个星包起来来就是加粗,一个星包起来就是斜体 加粗 斜体

  • 表格 示例:

    表头
    表格内容
    姓名
    ------
    张三
    李四
    姓名年龄性别
    章三12
  • 代码 三个反引号(编程语言名称) (反引号就是英语语言下~这个键) 三个反引号收尾

if (a > 0) {
  a = a + 1;
} else {
  a = 0;
}

3. 总结

好了,这是基础的 md 知识,说实话,挺不习惯的,不过平时写文档的时候,也不用这么频繁的使用这些标记符号,后续我会继续使用 md 来写,来尝试怎么更高效的来写文章。 另外我会尝试用 ai 开发一个 word 转 md 的小工具来尝试效果怎么样,估计市面上应该有很多类似的工具了。