MarkDown文本编辑工具笔记

13 阅读5分钟

文本编辑工具

当前市面上流行的文本编辑工具有很多,对编程人员来说,选择面会更广一些。这里介绍一些我较为常用的文本编辑工具,方便日常文本内容的记录。

Jupyter Notebook

Jupyter Notebook 是一款开源的交互式编程/文档工具,核心以「单元格(Cell)」为单位,支持代码运行、文本注释、公式编辑、图表展示一体化,能实现「代码 + 说明 + 结果」的实时联动,是数据分析、机器学习、科研实验、代码教学的主流工具,对新手友好且适配多语言开发。

这款工具对于编程人员是比较友好的,上手之后,编程运行和文本记录都会便捷好多,每个单元格可以修改Markdown和代码属性,方便内容梳理,并且可以导出为Markdown等多种文件,用起来很方便。不过,对于非编程人员来说,用不到代码工具,还要专程为此配置环境,多少有些繁琐,所以up是不太推荐滴。

在Anaconda环境使用Jupyter Notebook

新建一个conda环境,进入anconda prompt,在base环境下输入:

conda create -n 环境名 python=版本

示例:

conda create -n pytorchEnv python=3.10

为Anaconda环境安装ipykernel

进入环境:

conda activat 环境名 

装ipykernel:

conda install ipykernel

为jupyter添加内核(此时我们仍在新建的anaconda环境中):

python -m ipykernel install --user --name 环境名称 --displ -name 展示名

两个名称可以相同,如:

python -m ipykernel install --user --name pytorchEnv --display-name pytorchEnv

退出环境,ase中打开jupyter

退出环境:

conda deactivate 

打开jupyter:

jupyter notebook 

修改Jupyter主题和字体

在conda的base环境下执行以下指令:

pip install jupyterthemes

执行以下指令查看所有主题:

jt -l

执行以下指令选择主题:

jt -f inconsolata -t onedork -fs 15

重启之后基本就修改成功了。

Jupyter界面汉化

若使用的是Jupyter Notebook,需将其版本升级到7.0以上,在conda软件界面,找到Jupyter Notebook的设置,点击Update application直接升级即可。

在conda的base环境下执行以下指令:

pip install jupyterlab-language-pack-zh-CN

之后在Jupyter Notebook界面的Settings的language下选择中文。

Markdown工具及语法

Typora工具及配置

  • 主题配置:安装好Typora后,菜单栏点击:文件-偏好设置-打开主题文件夹,将预备的主题导入进来,重新启动后,菜单栏点击主题即可配置。
  • 截图自动生成图片文件夹:文件-偏好设置-图片-copy image to ./asset

基础排版美化

标题层次
    # 一级标题 - 用于页面主标题
    ## 二级标题 - 用于主要章节  
    ### 三级标题 - 用于子章节
    #### 四级标题 - 用于细分内容
    ##### 五级标题 - 很少使用
文本强调
    **粗体文本** - 重要内容
     *斜体文本*   - 强调内容
    ***粗斜体*** - 特别重要
    ~~删除线~~    - 过时内容
    `代码片段`     - 行内代码

效果展示:

粗体文本 - 重要内容
斜体文本 - 强调内容
粗斜体 - 特别重要
删除线 - 过时内容
代码片段 - 行内代码

链接引用
[百度](https://www.baidu.com/ "一个搜索引擎")
参考前端CSS内容:
当前窗口打开:
<a href="https://www.baidu.com" target="self">百度</a>
新建窗口打开:
<a href="https://www.baidu.com" target="_blank">百度</a>

效果展示:

jupyter 7+ 设置代码自动补全
百度
百度

视觉分隔与结构

分隔线的三种写法
***
---
___
参考前端CSS内容:<hr>
空行控制技巧
段落之间保持一个空行

列表前后也要空行

代码块前后同样需要空行

列表美化技巧

无序列表
- 使用emoji增加视觉效果
- 保持统一的符号风格
- 内容简洁明了
- 合理使用图标

效果展示:

  • 使用emoji增加视觉效果
  • 保持统一的符号风格
  • 内容简洁明了
  • 合理使用图标
有序列表
1. 第一步:准备工作
2. 第二步:开始编写
3. 第三步:完成发布

效果展示:

  1. 第一步:准备工作
  2. 第二步:开始编写
  3. 第三步:完成发布
嵌套列表
- 主要内容
  - 子内容1
  - 子内容2
    - 更深层内容
    - 另一个深层内容
  - 子内容3
- 另一个主要内容

效果展示:

  • 主要内容
    • 子内容1
    • 子内容2
      • 更深层内容
      • 另一个深层内容
    • 子内容3
  • 另一个主要内容
引用块美化
> 这是一个简单的引用块

效果:这是一个简单的引用块

多行引用
> 这是引用的第一行
> 
> 这是引用的第二段
> 最后一行内容

效果展示:这是引用的第一行

这是引用的第二段 最后一行内容

引用嵌套
> 外层引用内容
> 
> > 这是内层引用
> > 可以有多行
> 
> 回到外层引用

效果展示:外层引用内容

这是内层引用 可以有多行

回到外层引用

代码块美化

行内代码
使用 `git commit` 命令可以提交代码
在文本中使用 `function()` 表示函数

效果:

使用git commit命令可以提交代码

代码块
使用```包裹代码```
使用
~~~html
包裹html代码,可定位语言
~~~

表格美化

基础表格
| 列1 | 列2 | 列3 |
|:---|:---:|---:|
| 左对齐 | 居中 | 右对齐 |
| 内容1 | 内容2 | 内容3 |
| 长内容展示 | 中等内容 | 短内容 |

效果:

列1列2列3
左对齐居中右对齐
内容1内容2内容3
长内容展示中等内容短内容
表格内使用格式
| 功能 | 描述 | 状态 |
|:---:|:---:|:---:|
| **搜索** | 全文搜索功能 | 完成 |
| **标签** | 文章分类标签 | 进行中 |
| **评论** | 用户评论系统 | 待开发 |
| `代码` | 代码高亮显示 | 未开始 |

效果:

功能描述状态
搜索全文搜索功能完成
标签文章分类标签进行中
评论用户评论系统待开发
代码代码高亮显示未开始
信息提示框
> **提示**: 这是一个有用的提示信息

> **警告**: 这需要特别注意的内容

> **错误**: 这是错误信息提示

> **信息**: 这是一般性信息提示

提示: 这是一个有用的提示信息

高级美化技巧

任务列表
- [x] 完成的任务
- [x] 另一个完成的任务
- [ ] 待完成的任务
- [ ] 未来的计划

效果:

  • 完成的任务
  • 另一个完成的任务
  • 待完成的任务
  • 未来的计划