Markdown学习笔记

最新推荐文章于 2024-01-19 11:46:42 发布
最新推荐文章于 2024-01-19 11:46:42 发布
阅读量381 收藏 1
点赞数
文章标签： markdown typo
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fantengt/article/details/109219064
版权

Markdown笔记

本文主要介绍了Makedown的基础语法和扩展语法

文章目录

Markdown 语法

基础语法

字体

标题
  1. 使用底线的语法
标题内容
========
或者
标题内容
--------
  • 底线 == 表示一级标题
  • 底线 — 表示二级标题
  • 底线符号至少2个
  • 这种语法只支持两级标题
  1. 使用 # 的语法（推荐）
# + 空格 + 标题内容
  • # 的个数代表标题的等级
  • 在# 后面添加一个空格
  • Markdown中最多支持前6级标题

注意：

  • 要保持间距，建议标题的前后都要空 1 行
  • # 与标题文本之间也要有 1 个空格，否则会导致阅读困难
  • 不要有多余的空格：建议标题要写在一行的开头，结尾也不要有空格
  • 建议标题的结尾不要有标点符号
  • 建议标题要尽量简短，方便引用
粗体和斜体

粗体语法

**加粗的内容**
或
__加粗内容__

斜体语法

*斜体内容*
或
_斜体内容_

注意：

  • 粗体和斜体建议使用 * 语法
  • 粗体和斜体内容建议不要有空格
高亮

语法：

==文字==
下划线

语法：

<u>文字</u>

下划线

脚注

语法：

我们可以这样引用一个脚注[^脚注]

[^脚注]:脚注的说明

示例：

我们可以这样应用一个脚注1

段落

​ Markdown 中的段落由一行或多行文本组成，不同段落之间使用空行来标记

  • 语法说明

​ 1） 如果行与行之间没有空行，则会被视为同意段落

​ 2） 如果行与行之间有空行，则被视为不同的段落

​ 3） 空行是指行内什么都没有，或者只有空格或者制表符

​ 4） 如果想在段内换行，则需要在上一行的结尾插入两个以上的空格然后按回车键

列表
  • 有序列表的语法
数字序号 + 英文句号 + 空格 + 列表内容
  • 无序列表语法
+/-/* + 空格 + 列表内容
  • 嵌套列表的语法
- 第一层列表
TAB - 第二层列表
TAB + TAB - 第三层列表

​ 说明：

​ 1） 列表中可以嵌套列表

​ 2） 有序列表和无序列表页可以相互嵌套

  • 使用规范

    1. 建议使用 - 标记无序列表
    2. 如果一个列表中所有的列表项都没有换行，建议使用一个空格
    3. 如果列表项有换行，则建议给无序列表使用3个空格，给有序列表使用2个空格
    4. 如果一个列表中的每个列表项都只有1行，建议列表项之间不要有空行
    5. 如果列表项中有换行，建议在列表项之间空 1 行，
分隔线
  • 分割线语法
***
或
---
或
___

  • 语法说明

    1） 分隔线使用至少3个以上的 */-/_来标记

    2） 行内不能有其他字符

    3） 可以在标记符中间加上空格

图片

  • 语法
![图片代替文字](图片地址)

  • 语法说明

    1） 图片地址可以是网络地址，也可以是本地地址

    2） 本地图片支持相对领和绝对路径两种方式

链接

1. 文字链接

文字链接就是把链接地址直接写在文本中

语法：

[链接文字](链接地址)

实例：

百度

谷歌

GitHub

2. 引用链接

把链接地址在某个地方统一定义好，然后在正文中通过“变量”来引用，可读性一下子就变强

引用链接是把链接地址作为“变量”现在Markdown文件的诶不定义好，然后在正文中进行引用

语法：

正文中引用链接标记
[链接文字][链接标记]

在底部链接标记
[链接标记]:链接地址

实例：

[百度][1]


[1]:www.baidu.com

百度

语法说明：

  • 链接标记可以有字母、数字、空格、和标点符号
  • 链接标记不区分大小写
  • 定义的链接内容可以放在任何位置，建议放在尾页
  • 当链接地址是网络地址时要以http/https开头，否则会被识别为本地地址
3. 网址链接

将网址或者邮箱用<>包裹起来会自动转换为超链接

语法：

<URL 或 邮箱地址>

实例：

18335909110@163.com

行内代码与代码块

1. 行内代码

语法：

`代码`

实例：

使用 cd ..命令切换到上一级目录

2. 代码块

代码块以4个空格或者Tab开头

​ printf(“hello”);

很多扩展语法提供了围栏代码块，并且支持语法高亮

3. 使用规范
  • 除行内代码可以使用包裹以外，转义或者强调某些字符，也可以使用包裹

示例：

若果你想跑路可以执行 `rm -f * /`命令
如果你不想`跑路`请限制执行删除权限
  • 如果代码超过1行，请使用围栏代码块，并显示的声明语言，这样做便于阅读，并且可以显示语法高亮

示例：

​```python
    print "hello"
​```
  • shell命令 中不能换行，因此可以在行尾使用 \表示换行
  • 建议在有输出内容的Shell命令前加$，没有输出内容的Shell命令前不要加​$

引用

语法：

> + 引用内容

说明：

  • 多行引用也可以在每一行的开头都插入>
  • 在引用中可以嵌套引用
  • 在引用中可以使用其他Markdown语法
  • 段落与换行的格式在引用中也是适用的

使用规范：

  • 建议在引用的标记符号>之后添加一个空格
  • 建议每一行引用都使用引用符号>
  • 不要在引用中添加空行

转义

语法：

\特殊符号

可以被转义的符号：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-E84TR6Bn-1603338479921)(E:\Markdown\image-可以被转义的符号.png)]

扩展语法（GFM）

删除线

语法：

~~被删除的文字~~

表情符号

语法：

使用：包裹表情代码即可

示例：

:smile:

😄

更多表情符号

自动连接

标准语法中使用<>包裹的URL地址被自动是别并解析为为超链接

扩展语法可以不是用<>包裹，自动连接只是别以www或http://开头的URL地址

如果不想使用自动连接， 也可以使用 `` 包裹URL地址

表格

语法：

|表头1 | 表头2 | 表头3 |
|---- | ---- | -----|
|内容1 | 内容2 | 内容3 |
|内容1 | 内容2 | 内容3 |

说明：

  • 单元格使用|来分割开，建议最前和最后都是用|

  • 单元格和|之间的空格会被移除掉

  • 表头和其他行使用----来分隔

  • 表格对其格式如下

    1. 左对齐（默认）：:----
    2. 右对齐：----:
    3. 居中对齐：:----:

  • 块级元素（代码区块，引用区块）不能插入表格中

任务列表

语法：

- [ ] 未勾选
- [x] 已勾选

示例：

  • 喝

  • 吃

    • 睡

围栏代码块

语法：

​```语言类型
代码片段
​```
或者
~~~语言类型
代码片段
~~~

语法说明：

使用连续 3个 ` 或者3个~~~包裹

锚点

​ 锚点，也称书签，用来标记文档特定位置，使用锚点可以跳转到当前文档或者其他文档中指定的标记位置

​ Markdown会被选人成HTML，在HTML页面中可以通过锚点实现跳转；Github、GitBook项目文档中的目录也是通过锚点实现跳转的

语法：

[锚点描述](#锚点名)

说明：

  • 锚点名建议使用字母和数字
  • 锚点名区分大小写
  • 锚点名中不能含有空格，也不能含有特殊字符

示例：

基础语法

排版技巧

关于空格

一些需要加空格的情况

  • 中文或者英文和数字之间要加空格
  • 英文标点符号和后面的字符之间
  • 当在中文、英文中使用>表示路径时，两边都需要加空格

不加空格的情况

  • 中文标点符号和数字、中文、英文之间不需要添加空格
  • 数字和百分号之间
  • 数字和单位符号之间
  • 英文和数字组合成的名字之间
  • 当/表示“或”、“路径”时，与前后的字符之间
  • 货币符号之间
  • 负号后不加空格

全角和半角

  • 全角：中文标点符号，占两个字节

  • 半角：英文标点符号和数字，占 1 个字节

  • 中文排版中，使用全角

  • 英文排版中，使用半角

正确的英文大小写

  • 专有名词要使用正确的大小写

Typora

编辑样式

操作快捷键
加粗Ctrl + B
斜体Ctrl + I
行内代码Ctrl + Shift + `
插入图片Ctrl + Shif + I
超链接Ctrl + K
链接引用无
删除线Alt + Shift + 5
表情与符号无

标题

操作快捷键
设置为 n 标题Ctrl + n
提升标题级别Ctrl + =
降低标题级别Ctrl + -
设置为普通文本Ctrl + 0

列表

操作快捷键
添加有序列表Ctrl + Shift + [
添加无序列表Ctrl + Shift + ]
增加缩进Ctrl + ]
减少缩进Ctrl + [
添加任务列表无
切换任务列表无

引用和水平分割线

操作快捷键
添加引用Ctrl + Shift + Q
添加水平分割线无

表格

操作快捷键
插入表格Ctrl + T
增加一行Ctrl + Enter
减少一行Ctrl + Backspace

代码

插入代码围栏

操作快捷键
插入代码围栏Ctrl + Shift + K

扩展样式

下划线

语法：

<u>这段文字有下户线</u>

快捷键： Ctrl + U

内联数学公式

需要开启设置：【偏好设置】→【Markdown】→【Markdown扩展语法】→【内联公式】

语法：

$数学公式$

示例：

分数： $ f(x, y) = \frac{x^2}{y^2} $
开根号: $ f(x, y) = \sqrt[n]{{x ^ 2} {y ^ 3}} $
省略号: $ f(x_1, x_2, \ldots, x_n) = x_1 + x_2 + \cdots + x_n $

$ f(x, y) = \frac{x2}{y2} $

$ f(x, y) = \sqrt[n]{{x ^ 2} {y ^ 3}} $

$ f(x_1, x_2, \cdots, x_n) = x_1^2 + x_2 + \dots + x_n $

上标和下标

语法：（对比公式中的上标和下标）

~下标内容~

^上标内容^

示例：

H2O

x2 + y2

高亮

语法：

==高亮内容==

注释

语法：

<!--我是注释-->

说明：

  • 在编辑好预览时，注释的内容会被显示
  • 在导出 PDF 或 Word 时，注释会被隐藏

清除样式

快捷键： Ctrl + \

数学公式块

语法：

$$
数学公式
$$

快捷键：Ctrl + Shift + M

示例：

$$
\mathbf{V_1} \times \mathbf{V_2} = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} & \frac{[\partial Y]}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$

$$
\mathbf{V_1} \times \mathbf{V_2} = \begin{vmatrix}

\mathbf{i} & \mathbf{j} & \mathbf{k} \

\frac{\partial X}{\partial u} & \frac{[\partial Y]}{\partial u} & 0 \

\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \

\end{vmatrix}
$$

目录

语法：

@[toc]

使用说明：

在需要插入目录的地方输入[TOC] 回车即可

脚注

我们可以这样引用一个脚注2

图表

序列图

Typora提供的序列图语法标记功能是基于开源项目js-sequence-diagrams

语法：

​```mermaid
sequenceDiagram
js-sequence-diagrams 语法
​```

示例：

张三 李四 李四，吃了吗？ 我显示在李四的右边 好久不见，三儿，我刚吃过！ 张三 李四
流程图

Typora 提供的流程图语法标记是基于开源项目flowchart.js

语法：

​```mermaid
flowchat
flowchart 语法
​```

示例：

Created with Raphaël 2.2.0 开始 我是帅哥 Yes or No? 结束 yes no
Mermaid

Typora 继承了Mermaid, Mermaid 支持使用文本的方式生成图表

Mermaid 序列图语法

语法参考链接

示例：

​```makdown
%% 序列图举例（注释）
sequenceDiagram
	张三->>李四: 吃了吗？
	李四-->>张三: 好久不见，三儿，我刚吃过！
	Note right of 李四: 我显示在李四的右边
​```
张三 李四 吃了吗？ 好久不见，三儿，我刚吃过！ 我显示在李四的右边 张三 李四
Mermaid 流程图

语法参考链接

示例：

​```mermaid
graph TD
A[开始] -->B(我是帅哥)
B --> C{Yes or No?}
C -->|Yes| D[结束]
C -->|No| B
​```
Yes
No
开始
我是帅哥
Yes or No?
结束
Mermaid 甘特图

语法参考链接

示例：

​```mermaid
%% 甘特图示例
gantt
dateFormat YYYY-MM-DD
	title 项目开发周期
	
section 需求评审
需求评审 	:2018-01-01,2018-01-02
section 功能开发
开发编码	:2018-01-03,2018-01-08
开发自测	:2018-01-08,2018-01-09
section 项目测试
第一轮测试	:2018-01-09,2018-01-14
第二轮测试	:2018-01-14,2018-01-16
​```

%% 甘特图示例
gantt
dateFormat YYYY-MM-DD
	title 项目开发周期
	
section 需求评审
需求评审 	:2018-01-01,2018-01-02
section 功能开发
开发编码	:2018-01-03,2018-01-08
开发自测	:2018-01-08,2018-01-09
section 项目测试
第一轮测试	:2018-01-09,2018-01-14
第二轮测试	:2018-01-14,2018-01-16

graph TD
A[开始] -->B(我是帅哥)
B --> C{Yes or No?}
C -->|Yes| D[结束]
C -->|No| B
​```




```mermaid
graph TD
A[开始] -->B(我是帅哥)
B --> C{Yes or No?}
C -->|Yes| D[结束]
C -->|No| B
Mermaid 甘特图

语法参考链接

示例：

​```mermaid
%% 甘特图示例
gantt
dateFormat YYYY-MM-DD
	title 项目开发周期
	
section 需求评审
需求评审 	:2018-01-01,2018-01-02
section 功能开发
开发编码	:2018-01-03,2018-01-08
开发自测	:2018-01-08,2018-01-09
section 项目测试
第一轮测试	:2018-01-09,2018-01-14
第二轮测试	:2018-01-14,2018-01-16
​```

%% 甘特图示例
gantt
dateFormat YYYY-MM-DD
	title 项目开发周期
	
section 需求评审
需求评审 	:2018-01-01,2018-01-02
section 功能开发
开发编码	:2018-01-03,2018-01-08
开发自测	:2018-01-08,2018-01-09
section 项目测试
第一轮测试	:2018-01-09,2018-01-14
第二轮测试	:2018-01-14,2018-01-16

  1. 飒飒的 ↩︎

  2. 这是脚注 ↩︎

PeterFanT
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
markdown教程
weixin_60313946的博客
07-29 1341
![image-20200210154710148](image-20200210154710148.png) # MarkDown基础 [基础篇视频讲解链接](https://www.bilibili.com/video/av87982836#reply2366896129) [画图篇视频讲解链接](https://www.bilibili.com/video/av88551739/) ## 标题 ```markdown # 标题名字（井号的个数代表标题的级...
如何使用JS-Sequence-Diagram和MkDocs在Markdown内生成序列图
weixin_26750481的博客
09-14 523
I found out about js-sequence-diagrams, a javascript library that makes turning text into vector UML sequence diagrams very simple. I wanted to be able to add these diagrams into my MkDocs markdown fi...
【MarkDown】CSDN Markdown之时序图sequenceDiagram详解
少莫千华
06-12 2961
序列图是一种交互图，显示进程如何相互操作以及按什么顺序操作。Mermaid可以渲染序列图.
Markdown 进阶语法：Mermaid 绘图 (二) - 顺序图 (Sequence Diagram)
小嗷犬的博客
07-06 1984
Mermaid是一个基于 JavaScript 的图表绘制工具，它使用类似 Markdown 的简单语法来编写，并动态地将它们渲染成图表。流程图(Flowchart) : 用关键词graph或flowchart表示顺序图(Sequence Diagram) : 用关键词表示类图(Class Diagram) : 用关键词表示状态图(State Diagram) : 用关键词表示实体关系图(Entity Relationship Diagram) : 用关键词erDiagram表示用户旅程图。
markdown 绘制流程图、时序图、甘特图
热门推荐
Bingo
06-25 1万+
这些复杂图形的绘制都是使用代码块实现的，指定代码块的解析语言，按照响应的绘制语法即可实现。 流程图——指定 mermaid（样式流程图） 或 flow （标准流程图）解析语言 时序图——指定 sequence（标准时序图） 或 mermaid（样式时序图） 解析语言 甘特图——指定 mermaid 解析语言 一、流程图 1. 样式流程图 基本语法...
实现UML 序列图 -- csdn MarkDown 第六篇 技术篇
帐前卒 专栏
03-17 4056
这一篇开始讨论代码层面的问题。主要是markdown的功能的设计实现。这一篇先从markdown外围的代码开始讲起： UML序列图是从https://github.com/bramp/js-sequence-diagrams copy得到的。当如这个UML代码还用到了两个JS,功能库和画图.<script src="underscore-min.js"></script> <script src=
markdown时序图语法
老衲不出家
01-10 7310
语法 - 代表实线 ， 主动发送消息，比如 request请求 &gt; 代表实心箭头 ， 同步消息，比如 AJAX 的同步请求 -- 代表虚线，表示返回消息，spring Controller return &gt;&gt; 代表非实心箭头 ，异步消息，比如AJAX请求 源码 sequenceDiagram Title: md时序图练习 participant 客户端 p...
markdown学习笔记
03-30
本人的markdown学习笔记，.md格式。可与文章相互参考。
Markdown进阶：序列图
zhishengqianjun的博客
07-01 1万+
什么是序列图​ 序列图（Sequence Diagram），又名时序图、循序图、顺序图，是一种UML交互图。它通过描述对象之间发送消息的时间顺序显示多个对象之间的动态协作。它可以表示用例的行为顺序，当执行一个用例行为时，其中的每条消息对应一个类操作或状态机中引起转换的触发事件。​ 上面的是百度百科的解释，通俗地讲，时序图，就是描述各个对象之间，不同时间，不同对象之前的动作
Markdown笔记软件
08-09
Markdown笔记软件
markdown常用语法笔记
最新发布
qq_43003456的博客
01-19 840
有序的直接数字后面跟着一个点就可以了，和咱们平时写的一样。markdown中分割线，能是你的文章结构更加清楚。鼠标右键选择插入 -->表格–>输入表格的列行信息。这些都可以是分割线，按照自己的习惯使用。
Markdown编辑器常用编写笔记
qq_58801558的博客
03-24 467
Markdown编辑器，Markdown常用语法，Markdown笔记，Markdown标题，文字背景，颜色，字体，Markdown甘特图，图表制作，图标内容居中，Markdown数学公式，目录制作，分类列表，Markdown结合HTML书写，Markdown图片，Markdown基础语法大全
markdown绘图插件----mermaid简介
weixin_33901641的博客
10-22 4697
作者：黄永刚 mermaid简介 当撰写文档的时候，对于流程图的生成大多使用Visio等繁重的工具，没有一种轻便的工具能够画图从而简化文档的编写，就像markdown那样。 mermaid解决这个痛点，这是一个类似markdown语法的脚本语言，通过JavaScript实现图表的生成。 先来看个例子: 1.流程图(fl...
CSDN-Markdown编辑器之UML序列图
weixin_33995481的博客
03-15 497
目录 目录 UML序列图简介 时序图元素 1角色Actor 2对象Object 3生命线Lifeline 4激活期Activation 5消息Message 时序图结构 连接建立的过程 呈现效果 示例二 呈现效果 对象顺序 呈现效果 跨对象的消息 呈现效果 相关文章 CSDN-Markdown...
Markdown教程
ALiang
07-19 516
Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。 Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。 Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。 Markdown 编写的文档后缀为 .md, .markdown Markdown 应用 Markdown 能被使用来撰写电子书，如：Gitbook。 当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息
markdown记笔记常用写法
weixin_41141811的博客
01-16 638
## 斜体 *我是斜体* ## 粗体  **我是粗体** ctrl + b ## 链接 [百度](http://www.baidu.com) ## 图片 ![图片](http://p1.pstatp.com/large/pgc-image/RF6XM9SFFpHNLZ) ## 标题1 我是标题一 =========== ## 标题2 我是标题2 ----------- ## 标题（1-...
Markdown 语法教程 For GitHub 记录代码笔记
EM宝宝的博客
03-02 480
Markdown 语法教程 For GitHub 记录代码笔记 作者： 吃火星的宝宝|朱盟| GitHub: embaobao Wechat: 吃火星的宝宝 链接: Markdown 语法笔记 mvc 笔记 注: 两个空格或两段文字之间空一行 为换行符号 开始学习啦！ 5分钟就ok ！ 按两下 键盘上最长的键：空格 好 ！ 没反应吧？ 他是换行用的！ # 这是标题 ## 这是二...
markdown的笔记（代码运用)
星幕·云影的博客
11-30 640
以下所有演示，后面紧接的都是它们的代码行。 一级标题# 一级标题二级标题## 二级标题三级标题### 三级标题四级标题#### 四级标题五级标题##### 五级标题六级标题###### 六级标题水平线（以下都是水平线（分割线）的使用） ___ --- ***文本样式This is bold text 加粗 **This is bold text 加粗**...
markdown笔记
07-27
- *1* *2* *3* [Markdown学习笔记](https://blog.csdn.net/Student_WangJX/article/details/123129292)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值