美文网首页
markdown——文档神器

markdown——文档神器

作者: 我与路口 | 来源:发表于2017-06-21 18:43 被阅读0次

2015年才开始接触MD,当时看着一小兄弟使用Mou行云流水般的写着接口文档,我愣了半天。后来,我也尝试使用之,渐渐地,离不开了,会议纪要、笔记、文档都必用MD。MD实在是太简洁,大幅提升写作效率的同时几乎无学习成本。但目前仍有一些网站未作好适配,实在可惜,比如知乎专栏、wiki、微信公众号等。

MD 简介

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。 —— 维基百科

  • 约翰·格鲁伯亚伦·斯沃茨 于2004年发明,制定了标准语法

  • ** Markdown 的特点**

    • 易读、直观、极简
    • 专注内容而非排版样式
    • 轻松的导出 HTML、PDF 和本身的 .md 文件

    由于这些优点,md已被作家、博客爱好者、程序员等各类人群广泛使用及推广。

  • 工具及应用

    • Mou for mac、sublime text、 MarkdownPad for win
    • github 、 简书
    • 拓展

MD 语法的简要规则

  1. 标题(#)

    • 代码

      # 一级标题
      ## 二级标题
      ### 三级标题
      #### 四级标题
      ##### 五级标题
      ###### 六级标题
      ###### 七级标题
      
      
    • 效果

      • 一级标题

      • 二级标题

      • 三级标题

      • 四级标题

      • 五级标题
      • 六级标题
      • 七级标题
  2. 列表

    • 无序列表(*、-或+ )

      代码

      * 第一行
      * 第二行
      * 第三行
      
      

      效果

      • 第一行
      • 第二行
      • 第三行
    • 有序列表 (行如1. 2. 3. )

      代码

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

      效果

      1. 第一行
      2. 第二行
      3. 第三行
  3. 区块引用(> )

    • 引用

    引用只需要在被引用的内容段落开头加上右尖括号('>')即可。你可以选择只在开头加一个。也可以在每行前面都加一个,效果是一样的。
    * 嵌套引用

     代码
     
     ```
     >  markdown真好用,好自为知
     >> 二级引用
     >>> 三级引用    
     >>  
     >> 知难而退(前面需要一个视觉上的空行表示内层嵌套的结束,空行前面的'>'可以有可以没有)
     >   
     > 退一步,海阔天空
     
     ```
     效果
     >  markdown真好用,好自为知
     >> 二级引用
     >>> 三级引用    
     >>  
     >> 知难而退 
     >   
     > 退一步,海阔天空
    
  4. 分割线

    分割线可以由* - _(星号,减号,底线)这3个符号的至少3个符号表示,注意至少要3个,不需要连续

    华丽的分割线***


    华丽的分割线---


    华丽的分割线___


  5. 链接及图片

    支持两种链接方式:行内式和参数式,不管是哪一种,链接文字都是用 [方括号] 来标记。

  • 行内式

    代码

    ```
    
    • 百度是个什么网站
    • 图片 photophoto
      
      

    效果

    • 百度是个什么网站
    • 图片 photophoto
    • 参数式

    代码

    ```
     * [百度] [1] 是个什么网站
     * 图片 ![photo] [2]         
     * [1]: http://www.baidu.com            
     * [2]:  http://www.ccarting.com/img/opus/photograph/h000/h41/img201008181910520.jpg    "Optional title"
    ```
    

效果同行内式

  1. 代码框

    • 如果代码量比较少,只有单行的话,可以用单反引号包起来``

      代码

      ` public static void main(String args[]){}`
      

      效果

      public static void main(String args[]){}

    • 多行可以用两个 ``` 包夹

      代码

        ``` 
        import java.lang.String;
        public class Fuck(){
            public static void main(String args[]){
                System.out.println("xxxxxxx")
            }
        }
        ``` 
      

      效果

      import java.lang.String;
      
      public class Fuck(){
          public static void main(String args[]){
              System.out.println("xxxxxxx")
          }
      }
      
  2. 强调突出

    Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被 * 或 _ 包围的字词会被转成用 <em> 标签包围,用两个 * 或 _ 包起来的话,则会被转成 <strong>。
    另外md兼容HTML语言,因此颜色、字体、大小都可用<font/> 标签来控制

    代码

    <font color=red size=3 face="黑体">
    - 斜体 —— *是不是斜了*  _是不是斜了_
    - 加粗 —— **是不是粗了**  __是不是粗了__
    - 删除线 —— ~~求删除~~
    </font>
    

    效果

    • 斜体 —— 是不是斜了 是不是斜了
    • 加粗 —— 是不是粗了 是不是粗了
    • 删除线 —— 求删除
  3. 换行

在文本中输入的换行会从最终生成的结果中删除,浏览器会根据可用空间自动换行。如果想强迫换行,可以在行尾插入至少两个空格。

  1. 表格

    有多种表达方式,下面是我最常用的一种,很简练

    代码

    姓名|年龄|性别
    -|-|-
    张三|4|男
    李四|5|女
    

    效果

姓名 年龄 性别
张三 4
李四 5

相关文章

网友评论

      本文标题:markdown——文档神器

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