暂无图片
暂无图片
暂无图片
暂无图片
暂无图片

Markdown 扩展语法-PART A

闵栋 2022-12-28
440




Markdown 入门指南

Markdown 基本语法-PART A

Markdown 基本语法-PART B



Markdown 扩展语法简介

John Gruber的原始设计文档中概述的基本语法主要是为了应付大多数情况下的日常所需元素,但对于某些人来说还不够,这就是扩展语法的用武之地。

一些个人和组织开始通过添加其他元素(例如表,代码块,语法突出显示,URL自动链接和脚注)来扩展基本语法。可以通过使用基于基本Markdown语法的轻量级标记语言,或通过向兼容的Markdown处理器添加扩展来启用这些元素。

并非所有Markdown应用程序都支持扩展语法元素。您需要检查您的应用程序所使用的轻量级标记语言是否支持您要使用的扩展语法元素。如果没有,那么仍然有可能在Markdown处理器中启用扩展。


轻量标记语言

有几种轻量级标记语言是Markdown的超集。它们包含Gruber的基本语法,并通过添加其他元素(例如表,代码块,语法突出显示,URL自动链接和脚注)在此基础上构建。许多最受欢迎的Markdown应用程序使用以下轻量级标记语言之一:

  • CommonMark

  • GitHub Flavored Markdown (GFM)

  • Markdown Extra

  • MultiMarkdown

  • R Markdown


Markdown 处理器

有许多Markdown处理器可用。它们中的许多允许您添加启用扩展语法元素的扩展。查看您所使用处理器的文档以获取更多信息。




Markdown 表格

要添加表,请使用三个或多个连字符(---
)创建每列的标题,并使用管道(|
)分隔每列。您可以选择在表的任一端添加管道。


    |Syntax   |Description|
    |---------|-----------|
    |Header |Title |
    |Paragraph|Text |


    渲染的效果如下:

    SyntaxDescription
    HeaderTitle
    ParagraphText

    单元格宽度可以变化,如下所示。呈现的输出将看起来相同。


      |Syntax   |Description|
      |---|-----|
      |Header |Title |
      |Paragraph|Text |


      SyntaxDescription
      HeaderTitle
      ParagraphText

      Tip: 使用连字符和管道创建表可能很麻烦。为了加快该过程,请尝试使用Markdown Tables Generator。使用图形界面构建表,然后将生成的Markdown格式的文本复制到文件中。

      【扩展阅读】:

      https://www.tablesgenerator.com/

      自由配置,支持自动生成表格对应的html、text、markdown等的代码

      对齐

      您可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(:
      ),将列中的文本对齐到左侧,右侧或中心。


        | Syntax      | Description | Test Text     |
        | :--- | :----: | ---: |
        | Header | Title | Here's this |
        | Paragraph | Text | And more |


        渲染效果如下:

        SyntaxDescriptionTest Text
        HeaderTitleHere's this
        ParagraphTextAnd more


        格式化表格中的文字

        您可以在表格中设置文本格式。例如,您可以添加链接,代码(仅反引号(`
        )中的单词或短语,而不是代码块)和强调。

        您不能添加标题,块引用,列表,水平规则,图像或HTML标签。

        在表中转义管道字符

        您可以使用表格的HTML字符代码(|
        )在表中显示竖线(|
        )字符。




        围栏代码块


        Markdown基本语法允许您通过将行缩进四个空格或一个制表符来创建代码块。如果发现不方便,请尝试使用受保护的代码块。根据Markdown处理器或编辑器的不同,您将在代码块之前和之后的行上使用三个反引号((```
        )或三个波浪号(~~~)。


          ```
          {
          "firstName": "John",
          "lastName": "Smith",
          "age": 25
          }
          ```


          渲染效果如下:

          {
          "firstName": "John",
          "lastName": "Smith",
          "age": 25
          }

          Tip: 要在代码块中显示反引号?请参阅了解如何转义它们。

          语法高亮

          许多Markdown处理器都支持受围栏代码块的语法突出显示。使用此功能,您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示,请在受防护的代码块之前的反引号旁边指定一种语言。


            ```json
            {
            "firstName": "John",
            "lastName": "Smith",
            "age": 25
            }
            ```


            渲染效果如下:


              {
              "firstName": "John",
              "lastName": "Smith",
              "age": 25
              }



              Markdown 脚注

              脚注使您可以添加注释和参考,而不会使文档正文混乱。当您创建脚注时,带有脚注的上标数字会出现在您添加脚注参考的位置。读者可以单击链接以跳至页面底部的脚注内容。

              要创建脚注参考,请在方括号([^1]
              )内添加插入符号和标识符。标识符可以是数字或单词,但不能包含空格或制表符。标识符仅将脚注参考与脚注本身相关联-在输出中,脚注按顺序编号。

              在括号内使用另一个插入符号和数字添加脚注,并用冒号和文本([^1]: My footnote.
              )。您不必在文档末尾添加脚注。您可以将它们放在除列表,块引号和表之类的其他元素之外的任何位置。

              Markdown语法:


                Here's a simple footnote,[^1] and here's a longer one.[^bignote]


                [^1]: This is the first footnote.


                [^bignote]: Here's one with multiple paragraphs and code.


                Indent paragraphs to include them in the footnote.


                `{ my code }`


                Add as many paragraphs as you like.


                渲染的结果如下:

                Here's a simple footnote,[^1] and here's a longer one.[^bignote]

                [^1]: This is the first footnote.

                [^bignote]: Here's one with multiple paragraphs and code.

                  Indent paragraphs to include them in the footnote.


                  `{ my code }`


                  Add as many paragraphs as you like.










                  文章转载自闵栋,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。

                  评论