美文网首页
Markdown基础教程

Markdown基础教程

作者: 起源矢量 | 来源:发表于2020-12-26 19:16 被阅读0次

    Markdown 教程

    image

    Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

    Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

    Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

    Markdown 编写的文档后缀为 .md, .markdown。


    Markdown 应用

    Markdown 能被使用来撰写电子书,如:Gitbook。

    当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。


    编辑器

    本教程将使用 Typora 编辑器来讲解 Markdown 的语法,Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。

    支持导出HTML、PDF、Word、图片等多种类型文件。

    Typora 官网:https://typora.io/

    你也可以使用简书的编辑器去验证。


    有用的书籍

    《了不起的Markdown》:

    Markdown 标题

    Markdown 标题有两种格式。

    使用 # 号标记

    使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题

    展示效果

    一级标题

    二级标题

    三级标题

    四级标题

    五级标题
    六级标题

    Markdown 段落

    Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车

    你好

    我已经换行了。

    当然也可以在段落后面使用一个空行来表示重新开始一个段落。


    字体

    Markdown 可以使用以下几种字体:

    *斜体文本*
    _斜体文本_
    **粗体文本**
    __粗体文本__
    ***粗斜体文本***
    ___粗斜体文本___

    显示效果如下所示:

    斜体文本
    斜体文本
    粗体文本
    粗体文本
    粗斜体文本
    粗斜体文本


    分隔线

    你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

    ***
    * * *
    *****
    - - -
    ----------

    显示效果如下所示:







    删除线

    如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

    ~这是删除线~

    显示效果如下所示:

    这是删除线


    Markdown 列表

    Markdown 支持有序列表和无序列表。

    无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

    * 第一项
    * 第二项
    * 第三项
    + 第一项
    + 第二项
    + 第三项
    - 第一项
    - 第二项
    - 第三项

    显示结果如下:

    • 第一项
    • 第二项
    • 第三项
    • 第一项
    • 第二项
    • 第三项
    • 第一项
    • 第二项
    • 第三项

    有序列表使用数字并加上 . 号来表示,如:

    1. 第一项
    2. 第二项
    3. 第三项

    显示结果如下:

    1. 第一项
    2. 第二项
    3. 第三项

    列表嵌套

    列表嵌套只需在子列表中的选项前面添加四个空格即可:

    1. 第一项:
      - 第一项嵌套的第一个元素
      - 第一项嵌套的第二个元素
    2. 第二项:
      - 第二项嵌套的第一个元素
      - 第二项嵌套的第二个元素

    显示结果如下:

    1. 第一项:
      • 第一项嵌套的第一个元素
      • 第一项嵌套的第二个元素
    2. 第二项:
      • 第二项嵌套的第一个元素
      • 第二项嵌套的第二个元素

    Markdown 区块

    Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

    > 区块引用
    > Markdown教程

    显示结果如下:

    区块引用
    Markdown教程

    另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:

    > 最外层
    > > 第一层嵌套
    > > > 第二层嵌套

    显示结果如下:

    最外层

    第一层嵌套

    第二层嵌套

    区块中使用列表

    区块中使用列表实例如下:

    > 区块中使用列表
    > 1. 第一项
    > 2. 第二项
    > + 第一项
    > + 第二项

    > + 第三项

    显示结果如下:

    区块中使用列表

    1. 第一项
    2. 第二项
    • 第一项
    • 第二项
    • 第三项

    列表中使用区块

    如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。

    区块中使用列表实例如下:

    * 第一项

        > 区块引用
        > Markdown教程
    * 第二项

    显示结果如下:

    • 第一项

      区块引用
      Markdown教程

    • 第二项

    Markdown 代码

    如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

    `printf()` 函数

    显示结果如下:

    printf() 函数

    代码区块

    代码区块使用 4 个空格或者一个制表符(Tab 键)

    实例如下:

      printf("hello world!")

    显示结果如下:

     printf("hello world!")
    

    你也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

    ```javascript
    $(document).ready(function () {
    alert('hello');
    });
    ```

    显示结果如下:

    $(document).ready(function () {
        alert('hello');
    });
    

    Markdown 链接

    链接使用方法如下:

    [链接名称](链接地址) 或者 <链接地址>

    例如:

    这是一个链接 [Markdown教程](https://www.jianshu.com/u/b44b7da9f43d)

    显示结果如下:

    这是一个链接 Markdown教程

    直接使用链接地址:

    https://www.jianshu.com/u/b44b7da9f43d

    Markdown 表格

    Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

    语法格式如下:

    | 表头 | 表头 |
    | ---- | ---- |
    | 单元格 | 单元格 |
    | 单元格 | 单元格 |

    以上代码显示结果如下:

    表头 表头
    单元格 单元格
    单元格 单元格

    对齐方式

    我们可以设置表格的对齐方式:

    • -: 设置内容和标题栏居右对齐。
    • :- 设置内容和标题栏居左对齐。
    • :-: 设置内容和标题栏居中对齐。

    实例如下:

    | 左对齐 | 右对齐 | 居中对齐 |
    | :-----| ----: | :----: |
    | 单元格 | 单元格 | 单元格 |
    | 单元格 | 单元格 | 单元格 |

    以上代码显示结果如下:

    左对齐 右对齐 居中对齐
    单元格 单元格 单元格
    单元格 单元格 单元格

    Markdown 图片

    Markdown 图片语法格式如下:

    ![alt 属性文本](图片地址)
    ![alt 属性文本](图片地址 "可选标题")

    • 开头一个感叹号 !
    • 接着一个方括号,里面放上图片的替代文字
    • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。

    使用实例:

    ![我的主页](https://img.haomeiwen.com/i25241419/9e8ad972eb610649.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

    显示结果如下:

    我的主页

    以上是基础教程的全部内容,学习以上的内容基本能够正常使用markdown。

    写在最后

    使用 Markdown 的误区

    We believe that writing is about content, about what you want to say – not about fancy formatting.

    我们坚信写作写的是内容,所思所想,而不是花样格式。
    — Ulysses for Mac

    Markdown 旨在简洁、高效,也由于 Markdown 的易读易写,人们用不同的编程语言实现了多个版本的解析器和生成器。这就导致了目前不同的 Markdown 工具集成了不同的功能(基础功能大致相同),例如流程图与时序图,复杂表格与复杂公式的呈现。

    虽然功能的丰富并没有什么本质的缺点,但终归有些背离初衷,何况在编写的过程中很费神,不如使用专业的工具撰写来的更有效率,所以如果你需实现复杂功能,专业的图形界面工具会更加方便。

    当然,如果你对折腾这些不同客户端对 Markdown 的定制所带来高阶功能感到愉悦的话,那也是无可厚非的。

    相关文章

      网友评论

          本文标题:Markdown基础教程

          本文链接:https://www.haomeiwen.com/subject/ezvgnktx.html