Pycharm+Markdown 编程、笔记两不误
Markdown
是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Pycharm
为我们提供了Markdown
插件,使得我们在编辑代码时,可以方便的进行代码说明、笔记记录等。
1. Pycharm使用Markdown
- 当前最新版本的Pycharm是默认开启Markdown功能的,因此只需要在你的工程文件夹下新建一个
.md
文件即可。打开Pycharm双击.md
文件即可打开。打开后,左边为编辑区,右边为显示区。
- 若Pycharm没有安装Markdown插件,则打开Pycharm,按
File>Settings>Plugins>Marketplace
搜索Markdown
,点击安装即可。
2. Markdown语法(精简版)
特别说明:本语法为Markdown入门系列,仅列出常规使用的语法,若语法有多种表示,也是选择较为常用的进行说明。如需补充,可前往Pycharm-Markdown支持、Markdown官网、维基百科。
Pycharm-Markdown-Guide
Markdown-Guide
Markdown-Wikipedia
2.1 标题
- 使用不同数量的
#
可以完成不同的标题,如下:
# 一级标题
## 二级标题
### 三级标题
2.2 序号
2.2.1 无序列表
- 可使用减号
-
后加空格使用,要表示层级,则在-
前加空格,如下:
- 无序列表 1
- 无序列表 2
- 无序列表 2.1
- 无序列表 2.2
- 无序列表 3.1
- 无序列表 3.2
2.2.2 有序列表
- 在数字及符号点
.
后加空格后输入内容,如下:
1. 有序列表
1.1 有序列表
1.2 有序列表
2. 有序列表
3. 有序列表
2.3 换行
- 换行需要使用
Tab+回车
2.4 字体
- 常用的字体格式如下:
*斜体文本*
**粗体文本**
***粗斜体文本***
2.5 代码
- 插入代码可以使用单反引号、Tab制表符、三反引号,反引号键在键盘的位置在
Esc
键下方:
①单反引号
'NRContent'
②Tab制表符
[Tab]NRContent
③三个反引号(可指定语言类型,如python)
'''java
NRContent
'''
2.6 图片及链接
- 图片插入时,如图片和.md文件在同一目录下,则直接写上图片的名称即可;若不在同一目录则找到图片,拷贝路径,格式如下:
①在同一目录下:

②非同一目录下:

链接插入格式如下:
[你给链接取的名字](链接地址)
效果如下:
2.7 表格及公式
- 当前Pycharm的Markdown不支持表格和公式插入。你可以进入网站Markdown在线编辑器,进行表格和公式编辑,截图插入你的md文件中。
- 表格都是用符号
|
来表示的,该符号在回车键上方。同时用:
来规定文本对齐位置,左边有:
则左对齐,左右都有,则居中。
|姓名 | 年龄 | 工作 |
| :----- | :--: | -------: |
| 小可爱 | 18 | 吃可爱多 |
| 小小勇敢 | 20 | 爬棵勇敢树 |
| 小小小机智 | 22 | 看一本机智书 |
Markdown的公式头尾用
&&
括起来,如下图。其语法规则类似LATeX,因此可以查看LATeX相关教程,此处不再赘述。
$$\(\sqrt{3x-1}+(1+x)^2\)$$
2.8 其它
①分割线:空一行+三个减号`-`
②删除线:删除的文字前后加两个`~`(shift+反引号键)
③脚注:>+空格
④HTML语法:<span style="display:block;text-align:right;color:orangered;">橙色居右</span>