MarkDown语法学习笔记

学习链接:https://markdown.com.cn/basic-syntax/


学习之前我们先来了解一下

MarkDown是什么?

        用官方的话说,Markdown是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档,可与HTML混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写,Markdown被大量使用,如Github、Wikipedia、简书等。

        但是我理解的是,学会了markdown标记语言,我们就可以写出了排版优美,格式整齐的网页一般的注释文本了,而且这个文本的拓展性很好,可以转成各种我们需要的格式,而且其支持性也很好,不会有系统不兼容的问题,是一种泛用性很强的注释性语言。

话都说到这份上了,不如让我们废话少说,直接学起来

编译软件

我使用的是Visual Studio Code,我们只要创建一个readme.md文件,便可以直接开始学习,下面我也将以为了写一个项目的说明文档为由,记录一下学习MarkDown语言的过程


1、标题

在单词或短语前面加上井号( # )就产生了标题

跟word一样,我们可以人为的划分标题等级,这个划分是通过井号的数量来确定的

例如,添加三个 # 表示创建一个三级标题,标题的效果如下

# README
### 主要内容

 由上图可以看到,编译软件自动帮我们确定了不同标题等级的字体大小,现在我们还不用关注字体和大小的设置,但是现在这样无法居中很不美观,于是我查阅了一下如何调整标题位置。

很遗憾MarkDown是不支持标题居中功能的,我们可以借助HTML语言来辅助设置,代码如下:

# <center>README</center>
### 主要内容

 这样就实现了大标题的居中

2、分段和换行

要创建段落,请使用空白行将一行或多行文本进行分隔。

在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行

下文是我添加的注释语段,其实际效果如下图

# README
### 主要内容
该文档主要记录了标签盒不同版本的PCB工程

v1是利用8-3编码器来记录刺激事件序号的版本,该版本由于8-3编码器在记录事件标签时,本就存在奇异值问题,即在无事件传入时的状态与第8位有事件传入时的电平输出相同,无法正常编码全部事件,故停止开发<SPACE><SPACE>  
v2是利用FPGA来编码刺激事件序号的版本,目前已测试本版电路图中FPGA可以正常使用,但还没有测试FPGA与MCU的数据通信情况,且这一版电路图需要修改FPGA部分电路,并将引出的多余引脚去除,无法作为发行版本使用,仍需改进

如果要展示删除的部分,可以在被删除的文本前后加上~,该部分文本将显示为被划掉的样子

 3、强调

粗体(Blod)

要加粗文本,请在单词或短语的前后各添加两个星号(asterisks)或下划线(underscores)。如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加两个星号

斜体(Italic)

要用斜体显示文本,请在单词或短语前后添加一个星号(asterisk)或下划线(underscore)。要斜体突出单词的中间部分,请在字母前后各添加一个星号,中间不要带空格。

一般强调部分通用前后加星号就可以了,加粗两个星,斜体一个星

4、引用

要创建块引用,请在段落前添加一个 > 符号

块引用可以包含多个段落,为段落之间的空白行添加一个 > 符号

块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号

这里感觉用于代码项目的注释会很方便,不过我没有尝试,这里放两张教程本身的图

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

提示:块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用,你需要进行实验以查看哪些元素有效

5、列表

有序列表

要创建有序列表,请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列,但是列表应当以数字 1 起始。

无序列表

要创建无序列表,请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

这一部分我也没有去尝试,教程中的代码实现如下图所示

 注意到是,列表中也可以嵌入MarkDown的其他元素

定义列表

一些Markdown处理器允许您创建术语及其对应定义的定义列表。要创建定义列表,请在第一行上键入术语。在下一行,键入一个冒号,后跟一个空格和定义。

任务列表

任务列表使您可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号-和方括号[ ],并在[ ]前面加上空格。要选择一个复选框,请在方括号[x]之间添加 x 。

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

6、MarkDown代码语法

代码

要将单词或短语表示为代码,请将其包裹在反引号 ` 中

如果你要表示为代码的单词或短语中包含一个或多个反引号,则可以通过将单词或短语包裹在双反引号(``)中

根据上述修改了我的README文档,效果如下

# ***README***


### **主要内容**

该文档主要记录了标签盒不同版本的PCB工程

v1是利用`8-3编码器`来记录刺激事件序号的版本,该版本由于`8-3编码器`在记录事件标签时,本就存在奇异值问题,即在无事件传入时的状态与第8位有事件传入时的电平输出相同,无法正常编码全部事件,故停止开发  
v2是利用`FPGA`来编码刺激事件序号的版本,目前已测试本版电路图中`FPGA`可以正常使用,但还没有测试`FPGA`与`MCU`的数据通信情况,且这一版电路图需要修改`FPGA`部分电路,并将引出的多余引脚去除,无法作为发行版本使用,仍需改进  

 代码块

要创建代码块,请将代码块的每一行缩进至少四个空格或一个制表符

    <html>
        <head>
        </head>
    </html>

7、分割线

要创建分隔线,请在单独一行上使用三个或多个星号 (***)、破折号 (---) 或下划线 (___) ,并且不能包含其他内容

# ***README***


### **主要内容**  

***

该文档主要记录了标签盒不同版本的PCB工程

v1是利用`8-3编码器`来记录刺激事件序号的版本,该版本由于`8-3编码器`在记录事件标签时,本就存在奇异值问题,即在无事件传入时的状态与第8位有事件传入时的电平输出相同,无法正常编码全部事件,故停止开发  
v2是利用`FPGA`来编码刺激事件序号的版本,目前已测试本版电路图中`FPGA`可以正常使用,但还没有测试`FPGA`与`MCU`的数据通信情况,且这一版电路图需要修改`FPGA`部分电路,并将引出的多余引脚去除,无法作为发行版本使用,仍需改进  

8、链接

超链接

链接文本放在中括号内,链接地址放在后面的括号中,链接title可选

其语法为:[超链接显示名](超链接地址 "超链接title")

PCB文件远程仓库链接: [PCB文件链接](https://github.com/hubery-wc/Nano-EEG)

 链接title是当鼠标悬停在链接上时会出现的文字,这个title是可选的,它放在圆括号中链接地址后面,跟链接地址之间以空格分隔。

 网页和Email地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

如下图所示:

 引用链接

引用样式链接是一种特殊的链接,我们可以将一些难懂的术语或其他参考文章链接到文章的某个单词或段落中。参考样式链接分为两部分:第一部分是在文中的需要链接的单词或语句处,第二部分是在文中其他地方包含的链接地址

链接的第一部分格式使用两组括号进行格式设置,第一组方括号包围应显示为链接的文本。第二组括号显示了一个标签,该标签用于指向您存储在文档其他位置的链接。

其代码如下所示:

[链接名词] [链接标签]

链接的第二部分格式使用以下属性设置格式:

  1. 放在括号中的标签,其后紧跟一个冒号和至少一个空格(例如[label]:)。
  2. 链接的URL,可以选择将其括在尖括号中。
  3. 链接的可选标题,可以将其括在双引号,单引号或括号中。

其代码如下所示:

[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"

可以将链接的第二部分放在Markdown文档中的任何位置。有些人将它们放在出现的段落之后,有些人则将它们放在文档的末尾(例如尾注或脚注)

9、图片

要添加图像,请使用感叹号 (!), 然后在方括号增加替代文本,图片链接放在圆括号里,括号里的链接后可以增加一个可选的图片标题文本

本地图片的支持相对路径也支持绝对路径,一般将图片放在与注释文档同一文件夹下,在括号中写入图片名称即可

网络图片则需要在括号中给出链接地址和图片名称,但只有在有网络时才能打开

此外,MarkDown也支持对图片进行链接,如下代码即为图片中嵌套链接:

[![沙漠中的岩石图片](/assets/img/shiprock.jpg "Shiprock")](https://markdown.com.cn)

这样可以通过点击图片跳转到指定链接。

10、转义字符

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 

以下列出的字符都可以通过使用反斜杠字符从而达到转义目的

CharacterName
\backslash
`backtick (see also escaping backticks in code)
*asterisk
_underscore
{ }curly braces
[ ]brackets
( )parentheses
#pound sign
+plus sign
-minus sign (hyphen)
.dot
!exclamation mark
|pipe (see also escaping pipe in tables)

11、表格

表格是整洁表达文本的有力工具,在MarkDown中创建表格有以下语法要求:

  1. 第一行包含表头,用竖线(|)分割
  2. 第二行将标题与单元格分开,并且必须包含三个或更多的破折号(-)
  3. 第三行之后通过竖线(|)分割每一列,竖线之间填入表格内容
  4. 在第二行的破折号左右添加冒号(:),可以将表格中的文本进行左对齐,右对齐或居中
  5. 在表格中的任意单元格中的文字是不能换行的,但若需要的话可以加入<br>强制换行

        

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值