markdown——文档神器


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. 链接及图片

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

  • 行内式

    代码

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

    效果

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

    代码

    ```
     * [百度] [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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,265评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,274评论 1 288
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,087评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,479评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,782评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,218评论 1 207
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,594评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,316评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,955评论 1 237
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,274评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,803评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,177评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,732评论 3 229
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,953评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,687评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,263评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,189评论 2 258

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,083评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,292评论 18 399
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,534评论 25 707
  • 2015.8.9 星期日 阵雨昨天阵雨躲着我偷偷了下了,中午吃完饭,赶上一小阵儿。它还遮遮...
    北境之风阅读 226评论 0 1
  • 日子还是要继续的。每次出操的时候,我们老师会检查我们女生的头发,那个时候学校有好多女同学都染了虱子,学校要求老师一...
    什么样的幸福阅读 149评论 0 0