开始使用github就接触了markdown,确实如它的宗旨所言"易读易写",语法简洁明了,功能比纯文本更强,是一种非常适用于网络的书写语言。并且一大优点是兼容HTML,只要不在markdown涵盖范围内的标签,都可以直接在文档里用HTML书写。

  相比HTML作为一种'发布'的格式,markdown是一种'书写'的格式。

  下面具体介绍一下markdown的各种语法:

段落、标题、区块代码

  一个段落是由一个以上的连接的行句组成,而一个以上的空行则会划分出不同的段落(空行的定义是显示上看起来像是空行,就被视为空行,例如有一行只有空白和 tab,那该行也会被视为空行),一般的段落不需要用空白或换行缩进。

  Markdown 支持两种标题的语法,Setext 和 atx 形式。Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),Atx 形式在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶。

  区块引用则使用 email 形式的 '>' 角括号。

Markdown 语法:

A First Level Header
====================
A Second Level Header
---------------------Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.The quick brown fox jumped over the lazy
dog's back.
### Header 3> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote

  输出 HTML 为:

<h1>A First Level Header</h1>
<h2>A Second Level Header</h2>
<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>
<p>The quick brown fox jumped over the lazy
dog's back.</p>
<h3>Header 3</h3>
<blockquote>
<p>This is a blockquote.</p>
<p>This is the second paragraph in the blockquote.</p>
<h2>This is an H2 in a blockquote</h2>
</blockquote>

  

修辞和强调

Markdown 使用星号和底线来标记需要强调的区段。

Markdown 语法:

Some of these words *are emphasized*.
Some of these words _are emphasized also_.
Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.

  输出 HTML 为:

<p>Some of these words <em>are emphasized</em>.
Some of these words <em>are emphasized also</em>.</p>
<p>Use two asterisks for <strong>strong emphasis</strong>.
Or, if you prefer, <strong>use two underscores instead</strong>.</p>

  

列表

无序列表使用星号、加号和减号来做为列表的项目标记,这些符号是都可以使用的,使用星号:

* Candy.
* Gum.
* Booze.+ Candy.
+ Gum.
+ Booze.- Candy.
- Gum.
- Booze.

  都会输出 HTML 为:

<ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
</ul>

  有序的列表则是使用一般的数字接着一个英文句点作为项目标记:

1. Red
2. Green
3. Blue

  输出 HTML 为:

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ol>

  

链接

Markdown 支援两种形式的链接语法: 行内 和 参考 两种形式,两种都是使用角括号来把文字转成连结。

行内形式是直接在后面用括号直接接上链接:

This is an [example link](http://example.com/ "With a Title").输出HTML为:<p>This is an <a href="http://example.com/" title="With a Title">
example link</a>.</p>

  参考形式的链接让你可以为链接定一个名称,之后你可以在文件的其他地方定义该链接的内容:

I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"输出HTML为:<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from <a href="http://search.yahoo.com/"
title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
title="MSN Search">MSN</a>.</p>

  

图片

图片的语法和链接很像。

行内形式(title 是选择性的):

![alt text](/path/to/img.jpg "Title")

  参考形式:

![alt text][id][id]: /path/to/img.jpg "Title"

  上面两种方法都会输出:

<img src="/path/to/img.jpg" alt="alt text" title="Title" />

  

代码

在一般的段落文字中,你可以使用反引号 ` 来标记代码区段,区段内的 &< 和 > 都会被自动的转换成 HTML 实体,这项特性让你可以很容易的在代码区段内插入 HTML 码:

I strongly recommend against using any `<blink>` tags.I wish SmartyPants used named entities like `—`
instead of decimal-encoded entites like `—`.输出HTML为:<p>I strongly recommend against using any
<code><blink></code> tags.</p>
<p>I wish SmartyPants used named entities like
<code>&mdash;</code> instead of decimal-encoded
entites like <code>—</code>.</p>

  如果要建立一个已经格式化好的代码区块,只要每行都缩进 4 个空格或是一个 tab 就可以了,而 &< 和 > 也一样会自动转成 HTML 实体。

If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:<blockquote>
<p>For example.</p>
</blockquote>输出HTML为:<p>If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:</p>
<pre><code><blockquote>
<p>For example.</p>
</blockquote>
</code></pre>

  

转载于:https://www.cnblogs.com/vitruvi/p/4310015.html

github中markdown语言的使用规则相关推荐

  1. sql azure 语法_在Azure Data Studio中学习用于SQL Notebook的Markdown语言

    sql azure 语法 Microsoft supports SQL Notebooks in Azure Data Studio. It is an exciting feature that a ...

  2. php 解析md文件格式,Git中Read.MD文件格式:Markdown语言详解

    之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解.但是在看到别人写的项目的README.md里 ...

  3. python语言变量命名规则有什-以下选项中,符合Python语言变量命名规则的是_学小易找答案...

    [填空题]与文件系统相比,数据库系统的数据冗余度___________,数据共享性___________. [填空题]在数据库体系结构中,两级数据映象分别是指___________之间的数据映象与__ ...

  4. Typora、github中的markdown不同的行间距

    markdown的换行分为段落内换行和段落外换行.段落内换行指的是两行属于同一段落,行间距较小.段落外换行指的是两行不属于同一段落,行间距较大. Typora中shift+enter是段落内换行,en ...

  5. 修改Github仓库中项目语言类型

    简介 众所周知,当我们使用Github 的时候,我们的项目语言很大程度上会影响别人的搜索和自己的强迫症被逼犯,那么我们是不是可以对我们的Github 项目的编程语言进行修改或者进行自主标明呢? 修改 ...

  6. github用相对路径显示图片_【图文详解】如何利用Github在Markdown中插入图片?

    最近尝试用利用Github在Markdown中插入图片,遇到诸多问题--主要是不知道如何用GitHub上传图片! GitHub是一个纯英文网站,网上目前有的教程又都较为简略,一般只有文字说明.但缺乏图 ...

  7. 哪些不符合python语言变量名_以下选项中不符合 Python 语言变量命名规则的是( )_学小易找答案...

    [单选题]下列各项中,关于银行存款业务的表述中正确的是( ).(2012年) [单选题]下列各项中,关于企业无法查明原因的现金溢余,经批准后应贷记的会计科目是( ). [多选题]计价软件中,在人材机汇 ...

  8. GitHub Flavored Markdown 中实现【页内跳转】

    GitHub Flavored Markdown 中实现[页内跳转] GitHub 并不直接支持 html 形式的跳转,但可以通过以下两种方法曲折实现: 1. 任意 # 标注的标题都会被添加上同名的跳 ...

  9. C语言用户自定义标识符的命名规则,c语言中用户标识符的命名规则介绍

    c语言中用户标识符的命名规则介绍 发布时间:2020-06-24 15:55:31 来源:亿速云 阅读:116 作者:元一 这期内容当中的小编将会给大家带来有关c语言中用户标识符的命名规则介绍,以专业 ...

  10. 下列变量名不符合python命名规范的是_下列选项中不符合Python语言变量命名规则的是...

    [单选题]下列Python保留字中,不用于表示分支结构的是 [单选题]以下程序的输出结果是: j = '' for i in "12345": j += i + ',' print ...

最新文章

  1. ACL Fellow 2021名单出炉!华为刘群、中科院自动化所宗成庆当选!
  2. Py之terminaltables:terminaltables的简介、安装、使用方法之详细攻略
  3. 博士生的经验就要传下去
  4. UVa11137 Ingenuous Cubrency
  5. 谷歌浏览器外贸版_针对谷歌SEO,你有哪些值得推荐的工具、插件、网站、app,或者技巧分享?...
  6. 以色辨位的Farmer(洛谷P5832题题解,Java语言描述)
  7. iScroll框架的修改
  8. H3C IS-IS实验
  9. 两个数组各个数相加或相乘变成一个矩阵求第K大
  10. 君正X1500基于Minios的crash分析
  11. FleaPHP和ThinkPHP(比较)
  12. 【推荐软件】艾奇卡拉OK歌词字幕制作软件
  13. php源码授权网络验证系统,WEB端管理网络验证授权系统源代码
  14. html修改文字颜色代码
  15. maven工程依赖war包提示Could not find artifact xxxxxxxxx
  16. Oracle ltrim() 函数详细用法
  17. Python GUI 编程tkinter--画五角星和简单的动画制作
  18. 利用Docker极速下载OpenJDK11源码
  19. OFC2020论文笔记 Th1B.2 IEEE 50 Gbs EPON (50G-EPON)
  20. PDF转图片哪个软件好?推荐这几个软件

热门文章

  1. 建武28a对讲机最大距离_小米对讲机再出新品:不但价格低,还能一键写频
  2. type(img).__module__ == np.__name__
  3. pandas数据归一化方法
  4. MATLAB 距离函数及用法
  5. python-ImageDraw
  6. 疫情之下,你有多久没回过家了?
  7. python实现mat格式数据解析处理,并转化为json格式数据
  8. 蛮力法求最大字段和时间复杂度_中文分词算法之--最大匹配法
  9. C++ Make、Makefile、CMake和CMakeLists关系
  10. C++ std::condition_variable wait() wait_for() 区别 怎么用 实例