美文网首页
.md(markdown)文件的基本编写语法

.md(markdown)文件的基本编写语法

作者: china_木木 | 来源:发表于2018-05-22 16:33 被阅读0次

    构建一个项目,往往需要反复实践与验证,初始构建使用xmind整理思路与需求,初具模型后,通过visio呈现流程+md说明性文件,以便团队开发。

    • 本文是我学习.md的笔记。

    什么是 Markdown

    Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们「使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档 」—— 维基百科>Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式,例如LaTeX,Docbook。Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如Pandoc;要么基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。如果你看不懂以上对 Markdown 的定义,那也无所谓。约翰·格鲁伯自己对Markdown的描述的重点也在于

    标题

    • 第一种: 前面带 # h几即前面写几个 #
    # 一级标签          >     <h1>一级标签</h1>
    
    • 第二种: 只能表示一级和二级标题,=和-的数量不限制,大于一个即可
     一级标签           >     <h1>一级标签</h1>
    =========
    
    • 第三种: 和第一种方式不同之处是 添加了结束标签
      # 一级标题 #                  >      <h1>一级标签</h1>
      ## 二级标题 ##              >      <h2>二级标签</h2>
      ### 三级标题 ###          >      <h3>三级标签</h3>
      ...
    

    列表

    ### 无序列表
    * 1                             · 1       
    + 1            > 预览            · 1
    - 1                             · 1  
    
    <ul>
      <li>1</li>
      <li>1</li>
      <li>1</li>
    </ul>
    

    ### 有序列表
    1. 列表                            1. 列表     
    2. 列表            > 预览          2. 列表
    3. 列表                            3. 列表
    
    !数字后面的点只能是英文点
    !!有序列表的序号是根据第一行列表的数字顺序来的
    
    <ol>
      <li>列表</li>
      <li>列表</li>
      <li>列表</li>
    </ol>
    

    引用

    分割线

    链接

    • 2种链接方式:行内式和参数式,链接文字用 [链接文字]标记 。
     ### 行内式
     [Windows/Mac/Linux 全平台客户端](https://www.zybuluo.com/cmd/)
    
    <p><a href="https://www.zybuluo.com/cmd/">Windows/Mac/Linux 全平台客户端</a></p>
    

    ###参数式
    [Windows/Mac/Linux 全平台客户端](https://www.zybuluo.com/cmd/ 'title属性')
    
    <p><a href="https://www.zybuluo.com/cmd/" title="title属性">Windows/Mac/Linux 全平台客户端</a></p>
    

    图片

    ![cmd-markdown-logo](https://www.zybuluo.com/static/img/logo.png)
    
    <p><img src="https://www.zybuluo.com/static/img/logo.png" alt="cmd-markdown-logo" title="" /></p>
    
    cmd-markdown-logo

    代码段

    • 单行使用 `` [ 反引号,键盘中esc下面那个键/英文状态下 ]
     `我是单行文本`
    

    预览结果 _> 我是单行文本

    • 多行使用 `````` 注意:这里是是前后三个 ```


    文本样式

      *字体倾斜*                >        <em>字体倾斜</em>
      _字体倾斜_
      **字体加粗**              >        <strong>字体加粗</strong>
      __字体加粗__
      ~~字体删除~~              >        <del>字体删除</del>
    
      ! 符号与字体之间不要有空格
    

    加强的代码块

    支持四十一种编程语言的语法高亮的显示,行号显示。

    非代码示例:
        ` ` `
          $ sudo apt-get install vim-gnome
        ` ` `
    
    $ sudo apt-get install vim-gnome
    

    JavaScript 示例:
    `` ` javascript
    /**

    • nth element in the fibonacci series.
      */
      function fib(n) {
      var a = 1, b = 1;
      return a;
      }
      document.write(fib(10));
      `` `
      !三个反引号之间没有空格
    /**
    * nth element in the fibonacci series.
    */
    function fib(n) {
    var a = 1, b = 1;
    return a;
    }
    document.write(fib(10));
    

    表格

    | 项目        | 价格    |  数量   |
    | --------    | -----: | :----:  |
    | 计算机      | \$1600  |   5    |
    | 手机        |   \$12  |   12   |
    | 管线        |    \$1  |   234  |
    
    : 是对齐方向
    
    项目 价格 数量
    计算机 $1600 5
    手机 $12 12
    管线 $1 234

    相关文章

      网友评论

          本文标题:.md(markdown)文件的基本编写语法

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