Markdown使用文档

简介: 1.什么是MarkdownMarkdown 的目标是实现「易读易写」2.行内HTMLMarkdown 的语法有个主要的目的:用来作为一种网络内容的写作用语言请注意,在 HTML 区块标签(div、p...)中不能使用Markdown 语法。

1.什么是Markdown

Markdown 的目标是实现「易读易写」

2.行内HTML

Markdown 的语法有个主要的目的:用来作为一种网络内容的写作用语言

请注意,在 HTML 区块标签(div、p...)中不能使用Markdown 语法。在区段标签(span、del、cite...)中可以使用

3.特殊字符自动转换

Markdown 允许直接使用这些符号 & < >...

*html实体不会被自动转换--©

<a href="">百度一下,你就知道</a>

不过需要注意的是,code 范围内,不论是行内还是区块, < 和 & 两个符号都一定会被转换成 HTML 实体,这项特性让你可以很容易地用 Markdown 写 HTML code

4.区块元素

Markdown 中 email 式的 区块引言 和多段落的 列表 在使用换行来排版的时候,不但更好用,还更好阅读。

4.1.标题

Markdown 支持两种标题的语法,Setext 和 atx 形式

Setext 形式是用底线的形式,利用 = (一级标题)和 - (二级标题),任何数量的 = 和 - 都可以有效果例如:

这是H1标题

这是H2标题

Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 级,(可以选择性地「关闭」atx 样式的标题,这纯粹只是美观用的)例如:

This is an H1

This is an H2

This is an H3

This is an H4

This is an H5
This is an H6

4.2区块引言

  • Markdown 也允许只在整个段落的第一行最前面加上>如:

这是一首诗:床前明月光,疑似地上霜,举头望明月,低头思故乡。 这一段还没结束吗?

这是一首儿歌:门前大桥下,游过一群鸭,快来快来数一数二、四、六、七、八。

  • 区块引言可以有级别(例如:引言内的引言),只要根据级别加上不同数量的>

这是一段内容

这是一段里面的内容

这是另一段内容

  • 引言的区块内也可以使用其他的 Markdown 语法,包括标题、列表、程序代码区块等

这是引言标题

这是引言内容

4.3列表

  • Markdown 支持有序列表和无序列表
  • 无序列表使用星号*、加号+或是减号-作为列表标记
  • 有序列表则使用数字接着一个英文句点

项目标记后面则一定要接着至少一个空白或 tab

  • 列表中使用引言
    列表中使用引言需要缩排
  • 如果要放程序代码区块的话,该区块就需要缩排两次
    <?php
        echo 'hello world';
    ?>

4.3程序代码区块

要在 Markdown 中建立程序代码区块很简单,只要简单地缩排 4 个空白或是 1 个 tab 就可以如:

    <div class="footer">
        在程序代码区块里面, & 、 < 和 > 会自动转成 HTML 实体
        ©
    </div>

4.4分隔线

  • 你可以在一行中用三个或以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西
  • 你也可以在星号中间插入空白
    如:


5.区段元素

5.1链接

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

行内形式的链接

只要在方块括号后面马上接着括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

百度

参考形式的链接

使用另外一个方括号接在链接文字的括号后面,而在第二个方括号里面要填入用以辨识链接的标签:

[链接文字][辨识链接标签]
[辨识链接标签]:

[百度][id]
[id]: http://www.baidu.com "title"

链接定义的形式为:

  • 方括号,里面输入链接的辨识用标签
  • 接着一个冒号
  • 接着一个以上的空白或 tab
  • 接着链接的网址
  • 选择性地接着 title 内容,可以用单引号、双引号或是括号包着

链接的定义可以放在文档中的任何一个地方,我比较偏好直接放在链接出现段落的后面,也可以把它放在文档最后面,就像是批注一样。
如:

最近[baidu][1]不能使用,[google][]也不能使用,那还有什么能用呢?
[1]: http://www.baidu.com
[google]: http://www.google.com

5.2强调

Markdown使用星号或下划线作为标记强调字词的符号

使用星号或下划线包围的会变为斜体
使用两个星号或下划线包围的会变为粗体

*aaaaaaaaa*
_bbbbbbbbbb_
**aaaaaaaa**
__bbbbbbbbbb__

注意符号两边不能有空白

5.3程序代码

如果要标记一小段行内程序代码可以使用,反引号引起来

要想获取字符串长度请使用`strlen()`函数

程序中代码中的&与<会被转成html实体,容易插入html代码
<a href="">aaa</a>

5.4图片

Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内和参考

行内图片的语法:

  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替换文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。

[图片上传失败...(image-4a964c-1528699767654)]
[图片上传失败...(image-81b268-1528699767657)]

参考式的图片语法则

![alt text][id]
[id]: ./1.jpg "美女"

注意:Markdown没有办法指定图片的宽高,如果想要指定宽高请使用html中的img标签

6.其它

6.1自动链接

Markdown 支持比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用方括号包起来
如:

<http://www.baidu.com>  
<bienzhu@lampbrother.net>

6.2转义字符

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号
Markdown 支持在下面这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜杠
`   反引号
*   星号
_   底线
{}  大括号
[]  方括号
()  括号
#   井字号
+    加号
-    减号
.   英文句点
!   惊叹号
相关文章
|
1月前
|
前端开发
914.【前端】Taro集成towxml渲染markdown文档
914.【前端】Taro集成towxml渲染markdown文档
50 2
|
7月前
|
Rust JavaScript Docker
提升 Markdown 文档协作:Let's Markdown介绍与部署
Let's Markdown 是一个开源项目,旨在简化 Markdown 文档的创建、编辑和共享。快速、最小的网络编辑器,使标记编辑协作,每个人都可以访问。它提供了一套工具和功能,使 Markdown 文档的处理变得更加轻松和高效。使用Rust和React.js构建。有关详细信息,请参阅GitHub仓库。
229 3
提升 Markdown 文档协作:Let's Markdown介绍与部署
|
9月前
|
前端开发
软件协会第01次活动第01次任务布置:typora文档编写&markdown语法
软件协会第01次活动第01次任务布置:typora文档编写&markdown语法
74 0
|
10月前
谈一谈|Markdown转为word文档
谈一谈|Markdown转为word文档
147 0
|
11月前
|
JavaScript
快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释
作为文档工具人,经常需要把代码里面的注释转换成语义化的 Markdown 文档,有时也需要进行反向操作。以前是写正则表达式全局匹配,时间长了这种方式也变得繁琐乏味。所以写了脚本来互转,增加一些便捷性。
77 0
快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释
|
11月前
|
Python Windows
工具:语雀导出MarkDown文档后图片修复
工具:语雀导出MarkDown文档后图片修复
374 0
Go --- 将Markdown格式转化为普通的文档格式
Go --- 将Markdown格式转化为普通的文档格式
Go --- 将Markdown格式转化为普通的文档格式
|
测试技术 数据库 数据安全/隐私保护
推荐一个牛逼的开源在线文档系统,支持Markdown和富文本编辑模式!
推荐一个牛逼的开源在线文档系统,支持Markdown和富文本编辑模式!
3395 0
推荐一个牛逼的开源在线文档系统,支持Markdown和富文本编辑模式!
|
Prometheus Kubernetes Cloud Native
Markdown编辑文档语法格式详解
Markdown编辑文档语法格式详解
MarkDown编辑器-MarkText使用文档
1.Why MarkText typora要收费使用了,🤔我们可以使用免费的开源软件MarkText来编写MarkDown文档 MarkText官方承认,将会永远免费开源此软件 MarkText 是一个带有各种降价扩展的降价实时预览编辑器。您可以简单地编写和编辑文本 安装地址: MarkText安装
1107 0
MarkDown编辑器-MarkText使用文档