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 支持在下面这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜杠
`   反引号
*   星号
_   底线
{}  大括号
[]  方括号
()  括号
#   井字号
+    加号
-    减号
.   英文句点
!   惊叹号
相关文章
|
6月前
|
JSON 前端开发 JavaScript
Docusaurus框架——快速搭建markdown文档站点介绍sora
Docusaurus框架——快速搭建markdown文档站点介绍sora
168 0
|
6月前
|
前端开发
914.【前端】Taro集成towxml渲染markdown文档
914.【前端】Taro集成towxml渲染markdown文档
380 2
|
8天前
|
IDE Java 开发工具
在 Vim 里为 Markdown 文档展示导航窗格
在一个很长的 Markdown 文档里要准确跳转到某标题并不容易,如果像 Word 那样有个导航窗格就好了。
23 6
|
2月前
基于typora编写Markdown文档
如何使用Typora编写Markdown文档的教程,包括软件设置、快捷键使用以及一些使用技巧。
57 18
|
4月前
|
JavaScript Java
Java 将Markdown文件转换为Word和PDF文档
【7月更文挑战第5天】Java中使用`Spire.Doc for Java`库可方便地将Markdown转换为Word或PDF。基本步骤包括导入模块,创建`Document`对象,加载Markdown文件,然后保存为目标格式(`.docx`或`.pdf`)。若遇到`Invalid UTF-8 stream`错误,需确保Markdown文件是UTF-8无BOM编码。页面设置可通过`PageSetup`类调整。注意,实际应用会依据具体需求和环境有所调整。
249 6
|
4月前
|
JSON 监控 数据挖掘
上网行为管理软件中的Markdown文档编写与格式化
Markdown是轻量级标记语言,用于快速排版和格式化文本,常见于技术文档和博客。基本语法包括:#(1-6个)创建标题,空行分隔段落,*或-创建列表,[文本](链接)插入链接,![文本](图片URL)插入图片。此外,还有代码块(```包围)、引用(&gt;)等高级格式。Markdown支持HTML嵌入以自定义样式,并广泛应用于上网行为管理等领域的文档编写。通过自动化脚本,能将监控数据提交至网站进行分析。
43 6
|
4月前
|
自然语言处理 开发者 Python
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
|
4月前
|
Unix Linux Shell
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
Sphinx是一个Python文档生成工具,它可以解析reStructuredText或Markdown格式的源代码注释,并生成多种输出格式,如HTML、LaTeX、PDF、ePub等。
|
4月前
|
存储 JavaScript Python
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
word文档转成Markdown文档并在Typora免费版添加图床-----想想都很香
157 0
|
6月前
|
存储 对象存储 C++
在 VS Code 中使用 OSS 进行 Markdown 文档编写
阿里云OSS对象存储服务是理想的存储解决方案,专门用于承载大量非结构化数据。在VSCode中编写Markdown文档时,手动上传图片至OSS并获取相应链接的过程通常复杂且耗时。为此,Aliyun OSS Uploader插件应运而生,以简化和优化此流程。它不仅能够自动将图片上传到OSS并生成可供插入的链接,还能在您需要时通过撤回链接,删除已上传的图片,极大地提升了效率和便捷性。