掌握Markdown翻译(Mastering Markdown)(5)(完结篇)

in #cn7 years ago

  Github定制语法

  补充说明:虽然标记为定制语法,但基本上很多Markdown解析器也是认识的。

  github.com对Markdown语法进行了扩展和定制,方便和增强了其中一些特性。需要注意的是,一些语法只能用于特定场景,比如只能用于问题和Pull操作的注释里面,包括@人名引用,和SHA-1引用。而任务列表则可以用于gist的场景。

  • 语法高亮

    标准格式如下:

    ​```javascript
    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }
    ​```
    

    也可以用空格进行缩进来表示:

        function fancyAlert(arg) {
          if(arg) {
            $.facebox({div:'#foo'})
          }
        }
    

    下面是一个Python代码片段,没有设置语法高亮:

    def foo():
        if not bar:
            return True
    
  • 任务列表

    当你提交问题时,如果包含一个任务列表,那么你可以随时查看任务的进度情况,在Pull请求里面它也同样有效!

    - [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
    - [x] list syntax required (any unordered or ordered list supported)
    - [x] this is a complete item
    - [ ] this is an incomplete item
    
  • 表格

    你可以通过用-符号创建表(仅第一行),然后将每个列用|分开,就得到了一个表格:

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

​ 结果如下:

First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column
  • SHA引用

    任何提交的SHA-1哈希引用会自动转换成一个链接。

    16c999e8c71134401a78d4d46435517b2271d6ac
    mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
    mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
    
  • 问题引用

    任何问题或Pull请求的编号都会自动转换成链接。

    #1
    mojombo#1
    mojombo/github-flavored-markdown#1
    
  • 用户名@mentions

    键入@符号,然后后面紧跟用户名,将通知该人来查看评论。这就是所谓的“通知”,你既可以通知到个人,也可以通知一个组织。

  • 自动生成链接

    任何URL(比如http://www.github.com/)都会自动转换为一个链接。

  • 删除线

    被两个波浪线包围的文字显示删除线,例如~~this~~

  • 表情符号

    GitHub 支持表情符号( emoji

    表情符号列表可查看 Emoji Cheat Sheet.

=====================================================

掌握Markdown翻译(Mastering Markdown)(1)
掌握Markdown翻译(Mastering Markdown)(2)
掌握Markdown翻译(Mastering Markdown)(3)
掌握Markdown翻译(Mastering Markdown)(4)