0. 前言


Markdown 是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。
现在的项目都使用了 git 仓库,再加上远程仓库 github 托管,那就难免要写一些 readme 等等的说明性文件,但是这样的文件一般都是.md 的文件,编写的语法自然跟其他格式的文件有所区别,至于为什么要用这种格式的文件,不要问我,我也不知道,但我们遵循最佳实践原则,跟着用就对了,本文也算是学习写 markdown 文件的一个笔记吧。

1. 标题的几种写法


  1. 前面带 #号,后面带文字,分别表示 h1-h6, 上图可以看出,只到 h6,而且 h1 下面会有一条横线,注意,# 号后面有空格

  2. 这种方式好像只能表示一级和二级标题,而且 = 和 - 的数量没有限制,只要大于一个就行
    4
  3. 这里的标题支持 h1-h6,为了减少篇幅,我就偷个懒,只写前面二个,这个比较好理解,相当于标签闭合,注意,标题与 #号要有空格
     
    那既然 3 种都可以使用,可不可以混合使用呢?我试了一下,是可以的,但是为了让页面标签的统一性,不建议混合使用,推荐使用第一种,比较简洁,全面
    为了搞清楚原理,我可以使用在线编写 markdown 的工具,发现实际上是把这些标签最后转化为 html 标签,如图:

    在线地址请看这里: markdown 在线编辑

2. 列表


  1. 无序列表

     

    可以看到,无序列表可以用 , + , — 来创建,用在线编辑器看,实际上是转换成了 ul>li ,所以使用哪个都可以,推荐使用 吧。

  2. 有序列表
     
    有序列表就相对简单一点,只有这一种方式,注意,数字后面的点只能是英文的点,特别注意,有序列表的序号是根据第一行列表的数字顺序来的,比如说:
     
     
    第一组本来是 3 2 1 倒序,但是现实 3 4 5 ,后面一组 序号是乱的, 但是还是显示 3 4 5 ,这点必须注意了。

3. 区块引用


比如说当你想对某个部分做的内容做一些说明或者引用某某的话等,可以用这个语句。
 
无序列表下方的便是引用,可以有多种用途,看你的需求了,用法就是在语句前面加一个 > ,注意是英文的那个右尖括号,注意空格,引用会终止于下一个换行符。
引用因为是一个区块,理论上是应该什么内容都可以放,比如说:标题,列表,引用等等,看看下图:
 
将上面的代码稍微改一下,全部加上引用标签,就变成了一个大的引用,还有引用里面还有引用,那引用嵌套引用还没有别的写法呢?

 

上图可以看出,想要在上一次引用中嵌套一层引用,只需多加一个 >,理论上可以无限嵌套,我就不整那么多了,注意:多层嵌套的 > 是不需要连续在一起的,只要在一行就可以了,中间允许有空格,但是为了好看,还是把排版搞好吧.

4. 分割线


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

 

为了代码的排版好看可以自己定规则吧,前面有用到星号,建议用减号。

5. 链接


支持 2 种链接方式:行内式和参数式,不管是哪一种,链接文字都是用 [方括号] 来标记。
 
上图可知,行内式的链接格式是:链接的文字放在 [] 中,链接地址放在随后的()中,举一反三,经常出现的列表链接就应该这样写:
 
链接还可以带 title 属性,好像也只能带 title,带不了其他属性,注意,是链接地址后面空一格,然后用引号引起来

这是行内式的写法,参数式的怎么写:
 
这就好理解了,就是把链接当成参数,适合多出使用相同链接的场景,注意参数的对应关系,参数定义时,这 3 种写法都可以:

12345
[foo]: http://example.com/ "Optional Title Here"[foo]: http://example.com/ 'Optional Title Here'[foo]: http://example.com/ (Optional Title Here)#还支持这种写法,如果你不想混淆的话:[foo]: <http://example.com/> "Optional Title Here"

其实还有一种隐式链接的写法,但是我觉得那种写法不直观,所以就不写了,经常用的一般就上面 2 种,如果你想了解隐式链接,可以看我文章最后放出的参考地址.

6. 图片


图片也有 2 种方式:行内式和参数式:
用法跟链接的基本一样,唯一的不同就是,图片前面要写一个 _!_

e.g.


这里是参数式图片:

7. 代码区块


要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以。
例如输入:

123
这是一个普通段落:

    这是一个代码区块。

Markdown 会转换成:

1234
<p>这是一个普通段落:</p>

<pre><code>这是一个代码区块。</code></pre>

也可以使用反引号标记代码。
如果代码量比较少,只有单行的话,可以用单反引号包起来,如下:
 
要是多行这个就不行了,多行可以用三对反引号:
 
如果要写注释,可以在反引号后面写。

8. 表格


 

从这 3 种不同写法看,表格的格式不一定要对的非常起,但是为了好看,对齐肯定是最好的,第一种的分割线后面的冒号表示对齐方式,写在左边表示左对齐,右边为右对齐,两边都写表示居中,还是有点意思的,不过现实出来的结果是,表格外面并没有线框包起来,不知道别人的怎么弄的。

9. 强调


一个星号或者是一个下划线包起来,会转换为 <em> 倾斜,如果是 2 个,会转换为 < strong > 加粗。

 

10. 转义


使用反斜杠 “\“ 转义特殊字符。
 

11. 删除线


 

常用的基本上就这些了,如果还有一些常用的,会在后续更新。

参考文献:


MarkDown - 语法说明
.md 即 markdown 文件的基本常用编写语法(图文并茂)
Markdown 语法说明 (简体中文版)
认识与入门 Markdown

.md 即 markdown 文件的基本常用编写语法的更多相关文章

  1. 转 .md即markdown文件的基本常用编写语法(图文并茂)

    原文链接:.md即markdown文件的基本常用编写语法(图文并茂) 序言: 很久没有写博客了,感觉只要是不写博客,人就很变得很懒,学的知识点感觉还是记不住,渐渐地让我明白,看的越多,懂的越少(你这话 ...

  2. .md即markdown文件的基本常用编写语法(图文并茂)

    序言: 很久没有写博客了,感觉只要是不写博客,人就很变得很懒,学的知识点感觉还是记不住,渐渐地让我明白,看的越多,懂的越少(你这话不是有毛病吗?应该是看的越多,懂的越多才对),此话怎讲,当你在茫茫的前 ...

  3. .md即markdown文件的基本常用编写语法

    因为现在的前端基本上都用上了前端构建工具,那就难免要写一些readme等等的说明性文件,但是这样的文件一般都是.md的文件,编写的语法自然跟其他格式的文件有所区别,本文也是我学习写markdown文件 ...

  4. markdown文件的基本常用编写语法

    .md即markdown文件 1.标题的几种写法: 第一种:     前面带#号,后面带文字,分别表示h1-h6,上图可以看出,只到h6,而且h1下面会有一条横线,注意,#号后面有空格 第二种:   ...

  5. 为 github markdown 文件生成目录(toc)

    业务需要 在编写 github 项目时,有时候会编写各种 README.md 等 markdown 文件,但是 github 默认是没有目录的. 于是就自己写了一个小工具. markdown-toc ...

  6. 使用VS Code编写Markdown文件

    VS Code默认支持Markdown文件文件格式,这里介绍两个比较实用的功能,后续有新发现,可以持续更新. 实时预览 顾名思义,实时编辑,实时预览解析效果. 在VS Code扩展中搜索"M ...

  7. 【三】用Markdown写blog的常用操作

    本系列有五篇:分别是 [一]Ubuntu14.04+Jekyll+Github Pages搭建静态博客:主要是安装方面 [二]jekyll 的使用 :主要是jekyll的配置 [三]Markdown+ ...

  8. [csdn markdown]使用摘记二 快捷键及导入导出Markdown文件

    csdn推出了新的编辑器markdown,对于习惯使用离线编辑的人员来说是个大的福利,比如上班的时候,不能联网,但是又有好些知识点需要记录,等到下班了呢,又想直接把这些排版格式良好的文件直接上传到cs ...

  9. [原创]使用Pandoc实现Markdown文件转PDF文件

    Markdown写法简单明快,我十分喜欢,以至于我最近都想使用Markdown快速的进行测试说明书的写作,但是考虑到这文档是要进行交接的,一个.md的文件在内部传输还是有不便,于是就想到了能不能把Ma ...

随机推荐

  1. web容器(weblogic、resin、tomcat、jboss对比)

    WebLogic 12c Linux静默安装 weblogic11g 密码忘记解决方案 glassfish和tomcat各自的优势和劣势 Linux Resin4.0 安装配置(优质) 对比 . we ...

  2. javascript 给事件任务一个缓冲区

    在编写前端的过程中,经常会监听事件并执行任务,我在这抛出2个比较常见的场景: 1.输入关键字搜索如果你监听input的chage事件,会有一个问题,在使用中文输入法时,你输入的几个拼音字母都会被触发我 ...

  3. 01 Windows编程——Hello World

    源码 #include "stdafx.h" #include<Windows.h> int WINAPI WinMain(HINSTANCE hInst,HINSTA ...

  4. springmvc,hibernate整合时候出现Cannot load JDBC driver class 'com.mysql.jdbc.Driver

    原因:不清楚是什么原因,哪位知道可以给我留言,不胜感激! 解决方法: 1.把mysql的驱动包放到你项目的WEB-INF目录下的lib目录中2.要mysql的驱动包放在tomcat/lib目录下

  5. ORACLE归档日志满了之后,如何删除归档日志

    当ORACLE归档日志满后如何正确删除归档日志 版权声明:本文为博主原创文章,未经博主允许不得转载. 当ORACLE 归档日志满了后,将无法正常登入ORACLE,需要删除一部分归档日志才能正常登入OR ...

  6. flask例子

    1.例子:   https://blog.csdn.net/z564359805/article/details/83474387 def get_embedding(bc,query_list,ba ...

  7. PHP基础知识 - 字符串处理函数

    addcslashes — 为字符串里面的部分字符添加反斜线转义字符 addslashes — 用指定的方式对字符串里面的字符进行转义 bin2hex — 将二进制数据转换成十六进制表示 chop — ...

  8. Cairo初探

    https://blog.csdn.net/flexwang_/article/details/38000401 二维解析pdf

  9. 《流畅的Python》Object References, Mutability, and Recycling--第8章

    Object References, Mutability, and Recycling 本章章节: Variables Are Not Boxes identity , Equality ,  Al ...

  10. 前端与SQL

    转载自:http://developer.51cto.com/art/201706/542163.htm