前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >用 Visual Studio Code 打造优雅的 Markdown 编辑环境

用 Visual Studio Code 打造优雅的 Markdown 编辑环境

作者头像
Kindem
发布2022-08-12 12:11:48
7K0
发布2022-08-12 12:11:48
举报
文章被收录于专栏:Kindem的博客

🍜 预备知识

Visual Studio Code (VSCode) 是微软推出的一款开源编辑器,使用 Electron 打造,与 Atom 齐名,不过随着 Atom 社区的渐渐缩小,VSCode 的影响力开始越来越大了。VSCode 内置了 Markdown 语言及预览的支持,很适合用于编辑 Markdown 文档。

Markdown 是一种标记语言,可以在写文档的同时,通过添加一些特殊标记,快速完成文档的排版,很多程序员都喜欢使用 Markdown 来写文档,另外,github 也使用 Markdown 作为仓库 README 的标准语言,可以说是写技术文档的首选方案。关于 Markdown 的语法,可以在这里学习:菜鸟教程 - Markdown 教程

🍨 搭建环境

首先当然是下载安装 VSCode 啦,官网在 Visual Studio Code,一路安装即可,完成安装之后,打开 VSCode 界面如下:

VSCode UI
VSCode UI

VSCode UI

为了更好的编辑体验,我们可以先安装配色 One Dark Pro,这款配色沿袭自 Atom,是公认的比较舒服的几套配色之一,在侧边栏中的插件栏中搜索 One Dark Pro 并下载:

Plugins
Plugins

Plugins

完成安装之后,在顶部工具栏中依次点击 File -> Preference -> Color Theme,选择 One Dark Pro,即可看到效果:

One Dark Pro
One Dark Pro

One Dark Pro

之后我们需要配置一款舒适的字体,这里推荐 Fira Code,下载地址如下:Fira Code,下载 TTF 字体并安装即可,之后在 File -> Preference -> Settings 中依次更改这几项:

  • Font Size: 14
  • Font Family'Fira Code', Consolas, 'Courier New', monospace, 微软雅黑
  • Font Ligaturestrue

完成这几步之后,即可安装我们的核心插件 Markdown Preview Enhanced,参考之前的步骤:

Markdown Preview Enhanced
Markdown Preview Enhanced

Markdown Preview Enhanced

这样就完成了 Markdown 写作环境的搭建。

🍳 写作示例

如果要开始写作,首先要创建一个文件夹作为工作区,在想要的位置创建一个项目文件夹,这里我建的项目名叫 MarkdownProject

Markdown Project
Markdown Project

Markdown Project

右键 MarkdownProject 并点击 Open With Code,这样可以直接用 VSCode 打开项目文件夹。

点击如下两个按钮可以创建文件和文件夹:

Create File & Folder
Create File & Folder

Create File & Folder

我们在项目根目录下创建一个目录叫做 img,接着在根目录下创建一个文件 xx.mdimg 目录的作用是在本地存放图片,而 .md 文件则是文档的源文件,完成创建之后,即可在其中使用 Markdown 语法进行写作了:

Project
Project

Project

如果需要添加图片,推荐的做法是将图片存放到 img 路径下,并在 .md 文档中使用相对路径的形式引用:

代码语言:javascript
复制
![xx picture](./img/xx.png)

编辑的同时可以点击:

Example
Example

Example

注意不要点击另外一个类似的按钮,红框中的按钮是 Markdown Preview Enhanced 插件提供的优化版预览,而另一个是 VSCode 原生提供的预览,效果不敢恭维,点击预览之后,即可在书写文档的同时看到效果。

最后如果需要导出文档,则只需要在预览栏中点击右键:

Export
Export

Export

这里有很多种支持的格式,其中推荐使用 eBook 中的 HTML 格式,这样导出的文档不需要将图片打包一起带走,而是直接将图片使用内置编码放在文档中。另外,如果导出成 PDF 的话可能会出现分页问题,由于 Markdown 本身的原理就是转换成 HTML 渲染,再加上 Markdown 也是流式文档,HTML 将会是最好的导出格式。导出的文档可以在 .md 的同路径下找到。

😎 最后说几句

写得多才能写得好,多写文档,养成良好的习惯,文档写的越漂亮,才越会想写 🤣。希望各位能越写越好 👏

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 🍜 预备知识
  • 🍨 搭建环境
  • 🍳 写作示例
  • 😎 最后说几句
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档