文章目录

1 常用编辑器
2 基本用法
3 语法规则
- 3.1 标题
- 3.2 列表
- - 无序列表（*,+,-）
  - 有序列表（数字+点号）
- 3.3 文字格式
- 3.4 链接
- 3.5 图片
- 3.6 引用
- 3.7 水平分隔线
- 3.8 代码块(反引号`)
- - 代码句
  - 代码段
- 3.9 表格
- 3.10 目录
- 3.11 转义字符
Typora 设置
- 4.1 主题设置
- 4.2 图片设置
- 4.3 通用设置

Markdown是一种轻量级标记语言。它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的XHTML（或者HTML）文档。

由于Markdown的轻量化、易读易写特性，并且对于图片，图表、数学式都有支持，目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等，甚至还能被使用来撰写电子书。

1 常用编辑器

MarkDown Pad2
它的优点在于可以边写边预览效果，可以免费生成HTML文档，但生成PDF文档必须升级成专业版。这款软件目前用的人比较多。
Typora
Typora是一款所见即所得的Markdown文本编辑工具，在输入标记符号后，软件会自动对所标记的文本进行渲染，生成相应的格式。推荐使用

2 基本用法

单个回车，当作空格
连续回车，当作分段
行尾加两个空格，段内换行
注释可使用HTML的注释
可以使用HTML标签

3 语法规则

3.1 标题

# H1标题
## H2标题
### H3标题
#### H4标题
##### H5标题
###### H6标题

3.2 列表

无序列表（*,+,-）

* 列表1
* 列表2
+ 列表3
+ 列表4
- 列表5
- 列表6* 列表1* 子列表1* 子列表2
* 列表2

有序列表（数字+点号）

1. 列表1
2. 列表21. 子列表12. 子列表23. 子列表3
3. 列表3

3.3 文字格式

** 粗体 **
__粗体__*斜体*
_斜体_***粗斜体***
___粗斜体___~~斜体~~

3.4 链接

[链接名称](链接地址 “链接title”)

3.5 图片

![替代文本](链接地址 “链接title”)

3.6 引用

> 一级引用
>> 二级引用
>>> 三级引用

3.7 水平分隔线

---
___***

3.8 代码块(反引号`)

代码句

`这是代码块`

代码段

有两种方式，一种是tab键开始(或4个空格)。一种是用三个反引号`定义段的开始和结束。

```java
public static void mian() {
system.out.println(“Hello world!”);
}
```

3.9 表格

冒号:在左，在右，在两边代表居左，居右，剧中。

| 表头1| 表头2 | 表头3 |
| :-- | --:| :--: |
| xx | yy | zz |
| aa |  bb |  cc  |
| dd |  ff | ee |

3.10 目录

@[TOC]

3.11 转义字符

\\　反斜杠
\`　反引号
\*　星号
\_　下划线
\+　加号
\-　减号
\#　井号
\.　句号
\~　波浪号

Typora 设置

4.1 主题设置

选择自己喜欢的主题，例如我这选择Vue主题，进行下载

将下载后的压缩包解压，将以下3个文件放入Typora主题文件夹中

重启Typora软件，然后在主题中选择Vue

选择后，就会出现这样的效果啦~

4.2 图片设置

4.3 通用设置

Markdown 写文档做笔记的利器相关推荐

比Word更优雅的记笔记/写文档/交报告方式
比Word更优雅的记笔记/写文档/交报告方式 markdown+vscode->pdf 背景最近在上的一门<信息系统开发工具>课老师要求实验以后都要交实验报告,但是和以往不同的是, ...
直接用自己服务器做图床可以吗_图床+typora+gitee，写文档再也不那么麻烦
在上一篇文章中向大家介紹了几款软件,这篇文章主要分享一下markdown编辑器typora软件如何使用图床,快速的将图片加载到markdown文档中. 图床: 指存储图片的服务器,将图片上传到服务器上 ...
为什么程序员都不写文档？
‍‍‍ ‍ [CSDN 编者按]对于程序员来说文档可能是他最大的软肋.一些被称之为高手的程序员,往往是文档方面的处理会偏弱.不管这个程序员是在大公司.还在小公司.不管程序是写文档的.还是不写文档的,大 ...
程序员都讨厌写文档？这4个工具让你事半功倍
长按识别上方二维码,关注公众号:后端面试那些事回复"报告",获取你的GitHub年度报告! 对于一般的程序员来说,花费数小时来创建代码或修改现有代码只是一天工作中的一部分,简而言 ...
.net编写抽奖的文档_使用开源文档工具docsify，用写博客的姿势写文档
前提 ❝ 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 ❞ 「docsify」是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBoo ...
跟着吉庆写文档（流程图）の让“伊妹儿“帮你管理时间
第一版: 由于第一次写文档,只是知道工作所强调的主要内容,但是不知道应该以什么样的形式来表达而已.因此,只是写了一个大概的框架. 吉庆学长: 1)时间管理实际上就是个人管理 2)加载一些图片--图文并 ...
FreeRTOS官方指导文档阅读笔记
FreeRTOS官方指导文档阅读笔记基于 161204_Mastering_the_FreeRTOS_Real_Time_Kernel-A_Hands-On_Tutorial_Guide.pdf,可 ...
达梦数据库导出数据表结构为excel或html或文本（写文档用）
达梦数据库导出数据表结构为excel或html或文本(写文档用) 项目中用的是国产达梦数据库,项目做了一期后应该是要数据库设计文档.其中就有一个需要表结构(字段,字段精度,说明...) 因为是国产数据 ...
从程序员到项目经理（二十九）：怎样写文档
在软件项目中,文档既是一项的重要成果,也是项目管理的有力工具.通过文档,可以稳定.明确的传达信息,实现项目内的有效沟通.所以写文档对项目经理来说,是一项必备的技能. 然而很多项目经理害怕写文档,似乎 ...
解决写文档对于图片边框的强迫症
1. 写文档的困扰在写文档进行配图时,很多时候图片是白色背景的,会导致文章中的图片区域附近有大量空白的感觉,强迫症患者很难受. 目前语雀做的是很好的,可以给图片加边框或者阴影,而一些文档博客平台(C ...

Markdown 写文档做笔记的利器