# learnMarkdown

**Repository Path**: didali/learnmarkdown

## Basic Information

- **Project Name**: learnMarkdown
- **Description**: markdown学习记录
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-01
- **Last Updated**: 2023-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--GFM-TOC-->

* [关于Typora和Markdown](#关于Typora和Markdown)
  * [1.功能快捷键](#功能快捷键)
  * [2.页眉](#页眉)
  * [3.目录](#目录)
  * [4.标题](#标题)
  * [5.列表](#列表)
  * [6.引用](引用)
  * [7.任务列表](#任务列表)
  * [8.代码块和代码行](#代码块和代码行)
  * [9.高亮](#高亮)
  * [10.字体](#字体)
  * [11.删除线和下划线](#删除线和下划线)
  * [12.表情符号](#表情符号)
  * [13.下标和上标](#下标和上标)
  * [14.脚注](#脚注)
  * [15.链接](#链接)
  * [16.图片](#图片)
  * [17.转义](#转义)
  * [18.锚点](#锚点)
  * [19.其他](#其他)

<!--GFM-TOC-->

# 关于Typora和Markdown

`Markdown`是一种轻量级标记语言。允许人们使用易读易写的纯文本格式编写文档。推荐`Markdown`软件：`Typora`

熟练掌握`Markdown`语法，我们可以用它来编写博客、文档、和网页；

下述为一些`Markdown`中的基本语法。



## 功能快捷键

```
关于Typora中的一些常用快捷键
    撤销：Ctrl/Command + Z
    重做：Ctrl/Command + Y
    加粗：Ctrl/Command + B
    斜体：Ctrl/Command + I
    标题：Ctrl/Command + {1,2,3,4,5,6}
	段落：Ctrl/Command + 0
    链接：Ctrl/Command + K
    查找：Ctrl/Command + F
    替换：Ctrl/Command + H
    源代码模式：Ctrl/Command + ?
    引用：Ctrl/Command + Shift + Q
    任务列表：Ctrl/Command + Shift + X
    无序列表：Ctrl/Command + Shift + ]
    有序列表：Ctrl/Command + Shift + [
    插入链接：Ctrl/Command + Shift + L
    插入图片：Ctrl/Command + Shift + I
    显示\隐藏侧边栏：Ctrl/Command + Shift + L
```



## 页眉

`---`在第一行是页眉，在别的地方是分割线。

---

先按`---`再回车，就形成了上述的分割线的效果。

当然，为了兼容性，我们一般都会在分割线上下添加一行空行，如下：



---



## 目录

`[toc]+回车`，就会自动创建一个目录，我们可以点击目录中的标题，即可跳到对应的内容位置，效果如下（同时，我们的目录会根据我们自己的本篇文章中的标题内容自动更新，不用像 `word`那样重新引入目录，非常方便）：

[toc]



## 标题

```
在文件前面添加一个到六个 # 可以分别代表一级标题到六级标题；
	# 1			快捷键Ctrl + 1
    ## 2		快捷键Ctrl + 2
    ### 3		快捷键Ctrl + 3
    #### 4		快捷键Ctrl + 4
    ##### 5		快捷键Ctrl + 5
    ###### 6	快捷键Ctrl + 6
    (注意#和标题描述之间存在一个空格)
```



## 列表

无序列表可以在文字前面添加`*`、`+`、`-`号然后空格，三种符号任意选择一种即可，即可创建无序列表，效果如下：

- 
- - - -

有序列表，直接在数据后面加上英文的句号，然后空格就可以了：

1. 
2. 1. 



## 引用

> 使用一个>来创建引用
>
> > 我们同时可以再使用>创建嵌套引用



## 任务列表

任务列表可以来帮助我们了解自己未完成和完成了的项目。

我们可以通过 `- [ ]  `后面接上一个空格来创建任务列表，如下：

- [ ] 任务1
- [ ] 任务2

当然，在先打入`-`加上空格的时候会创建一个无序列表，这是正常的，接着输入`[ ]`就行了，注意`-`和`[`之间以及`[`和`]`之间都存在一个空格。



## 代码块和代码行

我们可以在两个``号`之间输入文字，即可形成代码行的效果，合理使用代码行能让我们的文档更加美观，同时能帮助我们有效的将文字与一行命令或者一行关键语句之间泾渭分明。

Typora仅支持GitHub Flavored Markdown 中的栅栏式代码块，不支持 markdown 中的原始代码块。

我们可以通过````之后输入一个可选的语言标识符，然后回车即可创建我们所需要的语言的代码块`

```java
//这是我通过 ```Java 创建的一个Java的代码块
    
public class {
    public static void main(String[] args) {
        System.out.print("hello world!");
    }
}
```



## 高亮

上述提到我们可以通过代码行使文字与命令等分隔开，方便于我们迅速找到关键。关于在文档中标注重点，我们还可以选择高亮操作。

首先，要使用高亮功能，首先进入 `Typora` 偏好设置中，进入 `Markdown`板块，勾选高亮来启用它。

我们可以通过在两个 `==`之间输入内容，该内容就会被高亮，如下：

==dida== `语法：==dida==` 只有在`Typora`中才能看到效果



## 字体

*斜体字* `在文字两边各加一个*即可，如左边显示即 *斜体字* `

_斜体字_ `在文字两边各加一个_即可，如左边显示即 _斜体字_`

**粗体字** `在文字两边各加两个*即可，如左边显示即 **斜体字**`

__粗体字__ `在文字两边各加两个_即可，如左边显示即 __斜体字__`

***粗斜体*** `在文字两边各加三个*即可，如左边显示即 ***斜体字***`

___粗斜体___ `在文字两边各加三个_即可，如左边显示即 ___斜体字___`



## 删除线和下划线

在文字两边都添加两个波浪线~即可使文字带有删除线，如下

~~这些字带有删除线~~ `语法为：~~这些字带有删除线~~`

Markdown并没有下划线的原生语法，因为会和链接的默认样式产生混淆，所以我们想要创建下划线就得使用行内HTML，如下

<u>这些字带有下划线</u> `语法为：<U>这些字带有下划线</U>`

[^要注明的文本]



## 表情符号

在`Markdown`中，我们可以选择性的添加一些表情符号，来丰富我们的文档内容。

输入表情符号的语法是在两个`:`之间键入，效果如下：

:smile: `语法为：:smile:`

:cry: `语法为：:cry:`

:jack_o_lantern: `语法为：:jack_o_lantern:`

`Markdown`中支持了很多的表情，感兴趣可以自己去研究一下。	



## 下标和上标

首先，要想使用这两个功能，我们首先的进入 `Typora`中的偏好设置中的 `Markdown`板块勾选对应的功能来启用。

我们可以在两个`~`符号中间键入我们想要的下标内容，如下：

H~2~O `语法为：H~2~O`

我们可以在两个`^`符号中间键入我们想要的下上标内容，如下：

X^2^+Y^3^ `语法为：X^2+Y^3^ `



## 脚注

脚注是对文本的备注说明，我们可以使用`[^]:`创建脚注，如下：

[^脚注：]:脚注是对文本的备注说明

`语法为：[^脚注：]:脚注是对文本的备注说明`

> 注意`]`后面是英文状态下的冒号`:`，关于脚注的效果只有在 `Typora`中才能看到效果，其他软件不知道是否支持



## 链接

链接的语法格式为`[链接名称](链接地址)` 或者 `<链接地址>`，如下：

文字链接：

[gitub](https://github.com)  `语法为：[github](https://github.com)`



网址链接

<https://github.com> `语法为：<https://github.com>`

在`Typora`中需要按住`Ctrl`再点击链接，才可以访问链接。



## 图片

图片的语法格式为：

```
![图片描述](图片地址)
或者
![图片描述](图片地址 "可选标题")
```

但是`markdown`目前无法做到指定图片的宽高，但是我们可以通过`<img>`标签来实现

同样`markdwon`也无法使用给类似标题文本居中的功能，但是这些功能都可以使用`html`文本添加

## 转义

`Markdown`中使用了很多特殊的符号来表示特定的意义，但同时该特殊符号也不会再显示，如果我们想要这些特殊符号显示出来，则需要转义字符，`Markdown`编辑器可以使用反斜杠`\`来进行转义特殊字符即可；

转义特殊字符格式：`\-转义`

\-转义

\*转义



## 锚点

锚点也就是书签，使用锚点我们可以跳转到当前文档或者其他文档的指定标记位置。

当我们在网页版`markdown`编辑器中想要创建目录时，我们会发现并不支持`[toc]`创建，因为使用`[toc]`创建目录是`markdown`的扩展语法，所以一般网页版和部分桌面端都不支持使用。但这个时候我们又想在网页版的`markdown`中创建如同目录一样的效果能根据点击跳转到响应的标题时我们应该怎么办呢？

这个时候我们就可以使用锚点功能，我们有两种方法实现`markdown`中的锚点功能。

```
//方法一：使用html中的 a 标签
<a href="#关于Typora和Markdown">返回顶部</a>

//方法二：使用 md 的特有语法
[返回顶部](#关于Typora和Markdown)

//注意：'#'后面跟的是标题的名称
```

展示效果：（在`Typora`中需要使用`Ctrl`+点击才可以进行跳转）

<a href="#关于Typora和Markdown">返回顶部</a>

[返回顶部](#关于Typora和Markdown)

同时，除了将标题定义为锚点之外，我们也可以自定义锚点目标，如带`id`特性的`HTML`标签（`id`特性的值为目标内容）、带`name`特性的`a`标签(`name`特性的值为目标内容）如下：

[前往未知的地方](#end)

> 注意：锚点的 目标内容 中不能有大家字母和空格，所以如果锚点目标的 目标内容 中有大写字母或空格，则需要在定义锚点中的 目标内容 时，把大写字母改成小写字母，把空格改成 `-`；
>
> 锚点的 目标内容 中不能含有以下字符：
>
> 1. 半角点(即英文中的句号).
>
> 2. 标签形式的锚点目标

## 其他

上述为`markdown`中一些常用的且不复杂语法，这些已经够我们来书写一份美观的平时的文档了，`markdown`还支持创建公式、流程图、UML图、表格等许多语法，感兴趣或者有需要的可以自行了解。

...



<a id="end">恭喜你看完这篇文档</a>