Markdown是一种轻量级标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTML格式发布。Markdown语言在2004年由约翰·格鲁伯(John Gruber)创建。Markdown编写的文档后缀为.md,可以导出为HTML、Word、图像、PDF、Epub等多种格式的文档。常见的Markdown编辑器有:Typora、MarkText、Mou等。
1. Typora简介
Typora 是一款支持实时预览的 Markdown 文本编辑器。它有 OS X、Windows、Linux 三个平台的版本。Typora V0.11.18是最后一个免费版本,后续版本需破解或购买激活(目前个人版是89¥,支持三台设备使用,提供免费升级服务)。
中文官网地址:https://typoraio.cn/
官方使用说明:https://support.typoraio.cn/zh/Markdown-Reference/
TyporaChina:https://typorachina.com/guide/
2. 常用快捷键
Typora中默认支持很多快捷键,在进行Markdown文档编写时,可以利用快捷键快速编辑。另外,Typora中也支持通过配置进行快捷键的自定义设置(文件->偏好设置 -> 打开高级设置->conf.user.json文件 -->修改 keyBinding 配置项即可)。常用的默认快捷键介绍如下:
- 加粗:Ctrl + B 或者以**或__包括住要表示为粗体的内容。
- 字体倾斜:Ctrl + I
- 删除线:以~~包括住要添加删除线的内容。
- 下划线:Ctrl + U 或者使用HTML标签包括住要添加下划线的内容。
- 撤销:Ctrl + Z
- 多级标题:Ctrl + 1~6 或者在行开头输入若干个#符号+空格,再输入文字。
- 有序列表:
输入数字+“.”之后输入空格
或者Ctrl + Shift + [
- 无序列表:
输入-之后输入空格
或者Ctrl + Shift + ]
- 任务列表:- [ ] 文字(注意 “-” 后与 “[]“ 中间都有空格)
- 降级快捷键:Tab
- 升级快捷键:Shift + Tab
- 插入链接:Ctrl + K
- 插入公式:Ctrl + Shift + M
- 行内代码:Ctrl + Shift + K
- 插入图片:Ctrl + Shift + I
- 返回Typora顶部:Ctrl + Home
- 返回Typora底部:Ctrl + End
- 选中整行:Ctrl + L
- 选中某个单词:Ctrl + D
- 选中相同格式的文字:Ctrl + E
- 搜索:Ctrl + F
- 搜索并替换:Ctrl + H
- 删除线:Alt + Shift + 5
- 引用:Ctrl + Shift + Q
- 创建表格:Ctrl + T
在表格单元格中可以通过Ctrl + Enter换行或创建新行。
想要修改列宽需要使用如下html的标签语法进行指定,示例如下:<span style="display:inline-block;width: 200px">列名</span>
3. 常用语法
在使用Typora进行Mrakdown文档编写时,需要用到一些Markdown编辑语法,常用的语法要点如下:
-
生成区域分割线:输入—或者***,然后回车,即可生成区域分割线。
-
生成菜单目录:输入[toc],回车,即可生成菜单目录。
-
导出时添加分页:在需要分页的地方插入如下HTML标签即可:
<div style="page-break-after:always;"></div>
-
高亮显示:在偏好设置中打开“Markdown扩展语法”功能设置,并使用==包裹住要高亮的内容。
-
下标输入:在偏好设置中打开“Markdown扩展语法”设置,并使用~包括住要添加下标的内容。
-
上标输入:在偏好设置中打开“Markdown扩展语法”设置,并使用^包括住要添加下标的内容。
-
插入表情:Typora语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。示例:😄smile 、😢cry、 :happy:happy
-
字体颜色添加:将需要添加颜色的字体部分写在行间公式中,格式如下:\color{颜色}{文字内容},示例如下: 文字内容 \color{red}{文字内容} 文字内容
-
中空字体设置:将需要设置为中空字体的部分写在行间公式中,格式如下:\mathbb{文字内容},
示例如下: 中空文字 T e s t \mathbb{中空文字Test} 中空文字Test -
引注:开头输入> + 空格,然后输入文字,按Enter键就会打开引注模式,双击Enter键跳出引注模式。
引注1:在要引用的文本前使用 大括号 + 空格,回车后即可开启引用
引注2:引注可以多层嵌套
引注2.1:引注内还可以嵌套列表或者代码块等
-
超链接:
普通超链接语法:
文字链接:[链接名称](http://链接网址) ,即用[]括住要链接名称,并用()括住超链接源 网址链接:<http://链接网址>,即直接使用<>括住链接网址。
高级链接技巧:使用
[超链接文字][标签]
的格式进行链接定义,并对标签变量进行备注,以创建自定义的链接。示例如下: -
换行与换段:
- 软换行:
Shift + Enter
,软换行只在编辑界面可见,当文档被导出时换行会被省略。 - 硬换行:
空格 + 空格 + Shift + Enter
,硬换行在文档被导出时将被保留,且没有换段的段后距。 - 在行尾输入换行符
- 换段:直接按Enter,Typora 会自动完成两次
Shift + Enter
的软换行,从而完成一次换段。
- 软换行:
-
代码块插入:
-
行间输入代码块
开头输入```+ 语言名,开启代码块,使用Enter换行输入代码。按方向键的下移键跳出代码块。快捷键:Ctrl + Shift + K
System.out.println("test!")
-
行内内容中插入代码块:用两个`包裹住正常段落中的标识代码即可。
示例:我是文本中的代码块
int a = 0;
示例。
-
-
数学公式编辑模块插入的三种方式:
- 点击“段落”—> “公式块”
- 快捷键:Ctrl + Shift + M
- 输入“$$”,然后回车
-
上传插入图片:
Typora文本文档中可以使用图片内容,如果需要发布在各个兼容Markdown的软件平台,需要预先上传文档中的图片至图床,再通过对图床的图片链接调用,才能正常显示,否则各个平台将无法看到该文档图片。
备注:图床就是专门用来存放图片,同时允许把图片对外连接的网上空间,许多图床都是免费的,当然也可以自己搭建图床,比如使用Gitlab。而图床工具就是可以自动把本地图片转换成链接的一款工具,比如PicGo。
-
上传图片的方式:
-
快捷键:Ctrl + Shift + I
-
直接将图片拖拽到指定区域或者Ctrl + V粘贴图片,自动生成链接。
-
使用如下语法编辑图片链接:
语法:![图片名称](http://图片网址)
-
使用类似自定义超链接的方式通过使用变量来自定义图片链接。
-
-
公式编辑:Typora支持Latex的公式编辑。公式编辑几乎和代码编辑的使用方法相同,同样分行内公式和行间公式,行内公式用两个$$+Enter就可以编辑公式。Latex符号查询工具Detexify:http://detexify.kirelabs.org/classify.html
-
Typora内置了对Mermaid的支持,可以支持三类流程图:sequence、flowchart、gantt。使用方法可参考:
https://blog.csdn.net/qq_36075612/article/details/118161100?utm_medium=distribute.pc_relevant.none-task-blog-2defaultbaidujs_baidulandingword~default-0-118161100-blog-121381426.235v43pc_blog_bottom_relevance_base1&spm=1001.2101.3001.4242.1&utm_relevant_index=1
4. 图片处理
Typora编辑器本身无法直接嵌入图片,插入的图片实际上插入的是图片的路径(相对路径或绝对路径),如果想要跨平台使用,比如要在将本地编辑的md文件上传到Gitlab仓库中时仍能正常显示文档中的图片,则需要配置图床,即使用图片的网络路径。Typora本身虽然不支持进行图片的上传,但支持配置上传服务器,我们可以通过使用Gitlab搭建图床,并配置PicGo图床工具进行图片上传来实现md文件中图片的跨平台使用。
4.1 图床搭建
4.1.1 下载安装PicGo
PicGo 一个开源的用于快速上传图片并获取图片 URL 链接的工具,可以帮助用户快速上传图片到各种图片托管平台,并生成图片链接。其开源地址为:https://github.com/Molunerfinn/PicGo
安装包下载地址:https://github.com/Molunerfinn/PicGo/releases
可根据系统情况下载指定版本的安装包,打开后根据提示安装即可。
4.1.2 PicGo中图床插件安装及配置
PicGo默认支持的图床中不包括GitLab,需要安装gitlab-files插件。下面列举了在线及离线两种方式:
在线安装:
通过PicGo的“插件设置”菜单搜索“gitlab-files”并点击安装即可:
离线安装:
方案一:
(1)在联网环境下通过在线安装的方式进行gitlab-files插件的安装,安装成功后会在C:\Users\用户\AppData\Roaming\picgo\目录下生成一个node_modules文件夹,下面保存的有gitlab-files插件信息。可以将该文件夹直接拷贝到离线环境中同一目录下。
(2)通过PicGo的“插件设置”菜单点击“导入本地插件”按钮进行导入:
(3)导入后PicGo可能会先提示导入错误,后又提示成功。报错日志如下:
此时查看C:\Users\用户\AppData\Roaming\picgo\node_modules\目录下的picgo-plugin-gitlab-files文件夹变成了一个快捷方式链接。可以将该快捷方式链接删除,并重新拷贝在线安装时得到的picgo-plugin-gitlab-files文件夹。
(4)关闭PicGo并重新启动,可以看到其图床设置菜单下已正常显示gitlab图床选项:
方案二:
(1)在能联网环境下下载源码到本地并解压。
源码下载地址:https://github.com/d-w-x/picgo-plugin-gitlab-files/tags
(2)利用yarn安装相关依赖,并使用 npm run electron:build
进行构建。构建成功后,会在 dist_electron
目录里出现构建成功的相应安装文件。—需要在本地环境下安装nodejs、yarn等
(3)将在线环境下构建生成的安装文件拷贝至离线环境,通过PicGo的“插件设置”菜单点击“导入本地插件”按钮进行导入。
图床设置:
图床配置参数信息需要从GitLab仓库中获取,Gitlab的安装及相应图片保存项目的创建此处略过。相关必选配置项包括gitlab服务器地址、项目id、默认分支、以及访问token(访问令牌生成后只会显示一次,需要将其保存下来方便后续使用)的获取方法如下图:
从Gitlab中取到相关信息后在PicGo中进行配置:
4.1.3 图片上传测试
4.2 Typora中图像处理配置
上述图床服务安装配置完成后,可以直接使用PicGo将本地图片上传至Gitlab进行保存。但如果想要在使用Typora时能快速进行图片上传,还需要在Typora中进行如下配置:
5. 导入/导出支持
在Typora中,一些文件格式(包括docx、odt、rtf、epub、LaTeX和wiki)的导入功能和导出功能由名为Pandoc的第三方软件提供支持的,这些功能需要安装Pandoc(≥v2.0)。对于Typora,安装Pandoc是可选的,如果不需要打字中的高级导入/导出支持,就不必在计算机上安装Pandoc。
特别提醒:经测试,安装Pandoc后使用Typora的导入功能将docx导入为md时会存在部分格式兼容异常问题,图片也无法正常显示。因此,对于图片较多的word文档,建议通过其他方式(比如利用Writage插件)先转换为Markdown文件,再用Typora进行编辑更新。
关于Pandoc的安装及在Typora中的配置进行过程如下:
5.1 Pandoc安装
Pandoc是由John MacFarlane开发的标记语言转换工具,可实现不同标记语言间的格式转换,是一个通用的文档文本转换器,堪称该领域中的“瑞士军刀”。Pandoc使用Haskell语言编写,以命令行形式实现与用户的交互,可支持多种操作系统;Pandoc采用GNU GPL授权协议发布,属于自由软件。简单来说,Pandoc 允许你将一些文件从一种标记语言转换为另一种标记语言。典型的例子包括将 Markdown 文件转换为演示文稿、LaTeX,HTML,PDF等文件。官网地址:http://pandoc.org/
备注:标记语言使用标签来标记文档的各个部分,常用的标记语言包括 Markdown、ReStructuredText、HTML、LaTex、ePub 和 Microsoft Word DOCX。
5.1.1 安装包下载
GitHub下载地址:https://github.com/jgm/pandoc/releases
南京大学镜像仓库下载地址:https://mirror.nju.edu.cn/github-release/jgm/pandoc/LatestRelease/
通过上述地址下载和安装环境的CPU架构相匹配的Pandoc安装包。
备注:在 Windows 系统中,你可以打开命令提示符(CMD)并运行命令 wmic cpu get ProcessorArchitecture
来查看 CPU 的型号信息。在 macOS 和 Linux 系统中,你可以在终端中运行命令 uname -m
来查看 CPU 的架构信息,比如是 x86_64 还是 ARM。
5.1.2 安装
Windows环境:可以下载xxx.msi文件然后进行手动安装,也可以直接下载xxx.zip压缩包进行解压后即可使用。
Linux环境:
# 将安装包解压到指定路径 语法:tar xvzf $TGZ --strip-components 1 -C $DEST $TGZ为安装包, $DEST为安装路径
tar -xvzf pandoc-3.1-linux-amd64.tar.gz
# 修改环境变量方便调用pandoc
vi ~/.bashrc
# 在.bashrc中添加如下内容
alias pandoc="/opt/knowledge/pandoc-3.1/bin/pandoc"
# 更新配置,使之生效
source ~/.bashrc
# 检查是否成功安装
pandoc -v
5.1.3 Pandoc常用命令
# 查看帮助
pandoc -h
# 格式转换
pandoc -f <源格式> -t <目标格式> -o <输出文件> <输入文件>
pandoc pandoc_userguide.docx -o pandoc_userguide.html
主要的参数选项说明:
-f <format>、-r <format>:指定输入文件格式,默认为 Markdown;
-t <format>、-w <format>:指定输出文件格式,默认为 HTML;
-o <file>:指定输出文件,该项缺省时,将输出到标准输出;
--highlight-style <style>:设置代码高亮主题,默认为 pygments;
-s:生成有头尾的独立文件(HTML,LaTeX,TEI 或 RTF);
-S:聪明模式,根据文件判断其格式;
--self-contained:生成自包含的文件,仅在输出 HTML 文档时有效;
--verbose:开启 Verbose 模式,用于 Debug;
--list-input-formats:列出支持的输入格式;
--list-output-formats:列出支持的输出格式;
--list-extensions:列出支持的 Markdown 扩展方案;
--list-highlight-languages:列出支持代码高亮的编程语言;
--list-highlight-styles:列出支持的代码高亮主题;
-v、--version:显示程序的版本号;
-h、--help:显示程序的帮助信息;
--shift-heading-level-by=NUMBER:调整文章标题的层级。如果其中的 NUMBER 设置为 1,那么一级标题就会变为二级标题,如果 NUMBER 设置为 -1,那么二级标题就会变为一级标题。
--wrap=preserve:表示不折行,Pandoc 默认设置行宽为 72,而preserve的作用是不折行,保持原样。
--extract-media=DIR:Pandoc会在本地新建一个文件夹 命名为DIR,将图床中的远程图片下载到本地并保存在该文件夹中,然后再输出为一个新的Markdown 文件output.md,并自动把原本的图床链接替换为本地图片链接。
5.2 Typora中配置Pandoc
6. Writage使用
Writage是一个Office插件,它能够使.docx文件另存为Markdown文件,并且将word文档中的图片统一保存在一个media文件夹中。对于一些已经存在的word文档,如果我们想要将其转换为Markdown文件,可以使用Writage插件来进行实现(个别特殊格式内容兼容上存在问题,需要自行校验更改)。关于Writage的安装使用,说明如下:
6.1 安装Writage
官网安装包下载地址:https://www.writage.com/download/
双击下载的“Writage-2.13.2.msi”文件,打开后根据提示信息安装即可。
6.2 Writage的使用
新建或打开任一Word文档,在“文件”菜单栏下选择“另存为”,在弹窗中的“保存类型”中可以看到有一个“Markdown(*.md)”选项,选择该选项并保存即可将Word文档转换为Markdown文档。