Markdown教程与常用工具

如果你对记笔记或者写文档时,处理格式问题烦恼?本文将为你提供一种解决方法。本文将对Markdown进行详细介绍,包括Markdown的简介,Markdown的主要用法,Markdown的相关语法,以及常用的编辑Markdown文档的在线工具与离线工具。

Markdown 是什么

Markdown 是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 页面。它诞生于 2004 年,由约翰·格鲁伯(John Gruber)和艾伦·纽曼(Aaron Swartz)设计。

Markdown主要用法

Markdown 主要用于写作,特别是在写技术文档时。它能够让写作者更专注于内容,而不是排版。另外,Markdown 还被用于很多在线平台,例如博客、论坛和社交媒体等。

Markdown 文件以.md结尾,但是可以使用工具方便地转换成HTML文件或者PDF文件。

微信公众号号平台后台编写文章时,我们可以直接将写好的Markdown文档复制粘贴这里。

程序员在github.com的repository中的REDEME.md文件也是常用Markdown进行编写。

Markdown主要语法

  • 标题

    在 Markdown 中,使用 # 号表示标题,一级标题使用一个 #,二级标题使用两个 #,以此类推。例如:

    # 一级标题
    ## 二级标题
    ### 三级标题

  • 列表

    在 Markdown 中,使用 * 或者 - 号表示无序列表,使用数字加点表示有序列表。例如:

    * 项目1
    * 项目2
    * 项目3
    
    1. 项目1
    2. 项目2
    3. 项目3
    • 项目1

    • 项目2

    • 项目3

    1. 项目1

    2. 项目2

    3. 项目3

  • 链接

    在 Markdown 中,使用 [链接文字](链接地址) 表示链接。例如:

    [玩哥编程](https://www.kexijiateng.com)

    玩哥编程

  • 图片

    在 Markdown 中,使用 ![图片文字](图片地址) 表示图片。例如:

    ![微信图片](https://open.weixin.qq.com/zh_CN/htmledition/res/assets/res-design-download/icon32_wx_logo.png)

    微信图片

  • 引用

    在 Markdown 中,使用 > 表示引用。例如:

    > 这是

    这是

  • 粗体和斜体

    在 Markdown 中,使用 ** 包含文字表示粗体,使用 * 包含文字表示斜体。例如:

    **这是粗体文字**
    *这是斜体文字*
    ***这是粗体加斜体***

    粗体

    斜体

    这是粗体加斜体

  • 表格

    在 Markdown 中,使用 |- 符号来创建表格。例如:

    | 左对齐 | 居中对齐 | 右对齐 |
    | :------ | :-------: | ------: |
    | 单元格1 | 单元格2 | 单元格3 |
    | 单元格4 | 单元格5 | 单元格6 |
    左对齐居中对齐右对齐
    单元格1单元格2单元格3
    单元格4单元格5单元格6

  • 代码

    在 Markdown 中,使用反引号(`)来标记代码。例如:

    这是一段普通文字,
    
    而这是一段代码:`function test() { console.log("Hello world!"); }`

    这是一段普通文字,

    而这是一段代码:function test() { console.log("Hello world!"); }

    如果需要在代码块中高亮显示多行代码,可以使用三个反引号来标记代码块的开头和结尾。例如:

    ```javascript
    function test() {
      console.log("Hello world!");
    }
    function test() {
      console.log("Hello world!");
    }

  • 分割线

    在 Markdown 中,使用三个或三个以上的 -* 或者 _ 表示分割线。例如:

    ---
    ***
    ___



  • 内嵌 HTML

    在 Markdown 中,可以直接使用内嵌 HTML 的方式来插入额外的格式。例如:

    <p style="color: red;">这是一段红色文字。</p>

    这是一段红色文字。

    注意:因为 Markdown 本身的语法已经能够满足大多数情况,所以并不鼓励大量使用内嵌 HTML。

  • 脚注

    在 Markdown 中,可以使用脚注的方式来标记文档中的注释或补充信息。例如:

    这是一段文字,[^1]会自动转换成脚注。

    这是一段文字,1会自动转换成脚注。

  • 转义字符

    在 Markdown 中,可以使用 \ 来转义特殊字符。例如:

    \*这是斜体文字\*

    *这是斜体文字*

  • 反斜杠

    在 Markdown 中,可以使用反斜杠 \ 来转义一些非法字符,使它们可以正常显示。例如:

    这是一段文字,\[这个字符不会被解释成标记\]。

    这是一段文字,[这个字符不会被解释成标记]

    反斜杠也可以用于转义 Markdown 的符号,使它们变成普通字符。例如:

    这是一段文字,\\ 表示一个反斜杠,\* 表示一个星号。

    这是一段文字,\ 表示一个反斜杠,* 表示一个星号。

    反斜杠的作用是让 Markdown 解析器忽略它后面的字符,不将它们解释成标记。这样,可以避免一些误解,提高文档的可读性。

  • 任务列表

    在 Markdown 中,可以使用 - [x]- [ ] 表示任务列表。例如:

    - [x] 完成任务1
    - [ ] 完成任务2
    • 完成任务1
    • 完成任务2
  • 表情符号

    在 Markdown 中,可以使用表情符号来表达情绪。例如:

    :smile: :laughing: :dizzy_face:

    😄 😆 😵

  • 数学公式

    在 Markdown 中,可以使用数学公式的语法来插入数学公式。例如:

    这是一个数学公式:$f(x)=x^2$

    这是一个数学公式:f(x)=x^2

  • 自动链接

    在 Markdown 中,可以使用 <链接地址> 的方式来自动生成链接。例如:

    这是一个链接:<https://www.google.com>

    这是一个链接:https://www.google.com

  • 参考文献

    在 Markdown 中,可以使用参考文献的方式来引用外部资源。例如:

    这是一段文字,[^2](https://chat.openai.com/chat#user-content-fn-1)会自动转换成参考文献。

    这是一段文字,2会自动转换成参考文献。

  • 内嵌 LaTeX

    在 Markdown 中,可以使用内嵌 LaTeX 的方式来插入数学公式。例如:

    这是一个数学公式:$f(x)=x^2$

    这是一个数学公式: f(x)=x^2

  • 删除线

    在 Markdown 中,可以使用两个波浪线 ~~ 来标记删除线。例如:

    这是一段文字,~~这个词语被删除了。~~

    这是一段文字,这个词语被删除了。

  • 强调

    在 Markdown 中,可以使用下划线 _ 来强调文字。例如:

    这是一段文字,_这个词语被强调了。_

    这是一段文字,这个词语被强调了。

  • 上下标

    在 Markdown 中,可以使用 ^~ 来标记上标或下标。例如:

    这是一段文字,x^2 或 x~2~。

  • 锚点

    在 Markdown 中,可以使用锚点的方式来定义文档中的跳转链接。例如:

    这是一段文字,[这里是链接](#锚点名称)
    
    ...
    
    <a name="锚点名称"></a>
    这里是锚点。

  • TOC

    使用[TOC]可以列出所有标题

使用Markdown的工具

  1. https://markdown.com.cn/editor/,一个中文网页可以在线编辑Markdown文档。

  2. https://dillinger.io/,一个英文网页可以在线编辑Markdown文档。

  3. Typora,一款轻量级的 Markdown 编辑器,它可以在 Windows、macOS 和 Linux 系统上运行。由于它的设计简洁且易于使用,因此在写作和编辑 Markdown 文档时非常受欢迎。目前需要付费。公众号【玩赚Python】后台回复Typora获取免费安装的方法。

参考资料

[1]  脚注的使用示范参考资料
[2]  参考文献的使用示范参考资料

发表评论