您现在的位置是:首页 > 博客日记 > 其他 其他

用markdown写下你的第一个md文档

2016-03-20 09:32:00 【其他】 人已围观

markdown 这个词的来源难道是为了对应编写网页所用HTML(超文本标记语言,Hyper Text Markup Language)中的markup?^_^

markdown 是什么?

同样是标记语言,但它相比HTML更加简单!一是体现在标记符的数量上,二是体现在标记符的书写上。HTML标记符号非常多,并且需要标记内容的开始和结束位置,而markdown只有四个基本的标记符号,只要在开始位置标记即可。

markdown 解决什么问题?

当我们需要让文档看起来层次分明,但又不依赖于word这样的编辑工具来书写、排版和读取时,markdown的易写易读优势就非常突出了。并且在我使用一段时间以后,发现使用markdown非常有助于帮助作者在写作时整理自己的逻辑思路和段落层次。

怎样书写和读取 markdown?

同HTML一样,你可以使用任何一款纯文本编辑工具来编辑和读取包含markdown格式的文本,但只有在一些特别的工具(如有道云笔记)或网站(如简书)下,才能呈现出渲染后的格式。同时markdown也可以使用HTML来添加格式和排版,这意味着,你即可以使用标准的markdown语法,也可以在其中嵌入HTML标记,但也只能对应其中的一小部分。

markdown 的语法

真的非常简单!

基本符号:<code> * - + > </code>

基本上所有的markdown标记都是基于这四个符号及其组合,需要注意的是,如果以基本符号开头的标记,注意基本符号后分割内容的空格。

  • 标题

    • 一级标题 <code># 一级标题</code>

    • 二级标题 <code>## 二级标题</code>

    • 三级标题 <code>### 三级标题</code>

    • 四级标题 <code>#### 四级标题</code>

    • 五级标题 <code>##### 五级标题</code>
    • 六级标题 <code>###### 六级标题</code>
  • 引用

引用的方式:> 引用内容

  • 段落

    • 段落以自然 回车 作为标记。
  • 分隔符

    • 连续输入三个以上的<code>—-</code>添加横线分隔符,如下:

  • 列表

    • 使用* - +中的任何一个符号加空格就可以创建无序列表,但如我这样的完美主义者可以进一步使用+ -来表现层次关系。
    • 使用数字+点+空格创建有序列表
    • 列表可以嵌套,使用时在嵌套列表前空格,这篇文章的列表使用了嵌套列表。
  1. * 这是一个无序列表
  2. * 这是一个无序列表
  1. + 这是一个父无序列表
  2. - 这是一个子无序列表
  1. 1. 这是一个有序列表`
  2. 2. 这是一个有序列表`
  1. ```
  2. * 也可以直接用尖括号包含网址的方式<http://www.jianshu.com>来构成链接 http://www.jianshu.com
  3. <https://blog.majiameng.com>
  • 图片

    • 像构造一个链接一样,只需要在前面加!

      1. ![图片名称](图片地址)

      简书

    • 也可以使用html方式来指定图片大小

      1. <img src="http://upload-images.jianshu.io/upload_images/95646-5bfd0cecf587c766.png" width="300px" height="240px" alt="简书">

      <img src="http://upload-images.jianshu.io/upload_images/95646-5bfd0cecf587c766.png" width="300px" height="240px" alt="简书">

  • 代码段

    使用

    1. 代码

    这样的方式来构建
    ` 符号在左上角esc键下方,请在半角状态输入

    1. print("这是一个代码段");
  • 字体样式

    • 倾斜 <code>倾斜</code>
    • 加粗 <code>加粗</code>
    • 倾斜并加粗 <code>倾斜并加粗</code>
  • 复选框

    *使用 - [ ]- [x] 语法可以创建复选框,实现 todo-list 等功能。例如:

      • 已完成事项
      • 待办事项1
      • 待办事项2
  • 表格

    • 使用- |符号把内容分割为你认为合适的表格样式就好。
    • 使用:符号标识对齐。

      1. |表头1|表头2|表头3|
      2. |:----|:-----:|-----:|
      3. |左对齐|居中对齐|右对齐|
表头1 表头2 表头3
左对齐 居中对齐 右对齐
  • 流程图
  1. st=>start: 用户登陆
  2. op=>operation: 登陆操作
  3. cond=>condition: 登陆成功 Yes or No?
  4. e=>end: 进入后台
  5. st->op->cond
  6. cond(yes)->e
  7. cond(no)->op
Created with Raphaël 2.1.2用户登陆登陆操作登陆成功 Yes or No?进入后台yesno
  • 以及时序图:
  1. Alice->Bob: Hello Bob, how are you?
  2. Note right of Bob: Bob thinks
  3. Bob-->Alice: I am good thanks!
Created with Raphaël 2.1.2AliceAliceBobBobHello Bob, how are you?Bob thinksI am good thanks!
  • 保存

    • 最后将markdown编写的文档存为 .md 格式,就可以用对应的工具查看效果和编辑了。


关注TinyMeng博客,更多精彩分享,敬请期待!
 

很赞哦! ()