基于 VSCode 和 Azure DevOps 实现 Markdown 笔记本地和在线管理

2019年12月21日


简介

Markdown

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。[4]这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

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

VSCode

Visual Studio Code ( 简称 VSCode ) 是一款免费开源的现代化轻量级代码编辑器,支持几乎所有主流的开发语言的语法高亮、智能代码补全、自定义热键、括号匹配、代码片段、代码对比 Diff、GIT 等特性,支持大量插件扩展,并针对网页开发和云端应用开发做了优化。软件跨平台支持 Win、Mac 以及 Linux。

Azure DevOps

Azure DevOps 是由微软公司研发,是提供给开发人员,以支持他们计划工作,代码协作,集成编译以及部署应用的服务平台。开发人员可以在云端工作(Azure DevOps Service) 或者可以自己搭建并托管(Azure DevOps Server)。Azure DevOps Server的前身叫 Visual Studio Team Foundation Server(TFS)。Azure DevOps 本身有很多功能模块,我们在线笔记管理与存储的话,只需要用到其中的 Azure Repos (代码仓库):它提供了两种代码存储方式GitTFVC,来对开发人员的源代码版本进行管理。现在,只需要把我们编写的 Markdown 文件当作代码文件一样就可以了,其他的交给工具去处理。

Git

Git 是一个开源的分布式版本控制系统,用于敏捷高效地处理任何或小或大的项目。Git 是 Linus Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。VSCode 需要调用 Git 进行文件版本管理,实现本地/远程 Markdown 文件同步,过程中无需手工执行 Git 命令。

配置内容

以下配置操作只在第一次配置时需要执行,以后使用过程中不需要再次执行。

安装 Git

下载 Git 并默认选择安装;关于 Git 的更多内容,请自行搜索。

安装 VSCode

下载 VSCode,安装版或Zip版皆可。

安装插件Markdown Preview Enhanced

VSCode 中安装 Markdown 扩展插件 Markdown Preview Enhanced,此插件针对 Markdown 的功能非常强大。

Azure DevOps 设置

  1. 浏览器访问 https://azure.microsoft.com/zh-cn/free/devops/ ,注册免费账户;
  2. 浏览器访问 https://dev.azure.com/,登录个人账户;
  3. 点击 New project ,创建一个新项目,输入 Project name (项目名称,自己定义,必要),Description (项目描述,可选),Visibility (可见性,选择私有 Private),点击 Creat ,创建成功并进入项目管理界面;
  4. 项目管理界面左侧导航连接栏选择 Repos > Files ,在 Clone to your computer 区域选择 Clone in VS Code,选择 VSCode 打开项目,选择项目文件保存目录位置,并在 VSCode 中打开项目;
  5. 设置完成;

日常使用

  1. 打开 VSCode ,在项目文件夹下可以新建文件夹,在文件夹下新建 Markdown 文件;
  2. VSCode 左侧工具栏中 源代码管理界面中,提交改动;然后点击 ... ,弹出菜单中选择 推送 ,即可同步到远程 Azure DevOps 资料库;
  3. 浏览器访问 https://dev.azure.com/,在 项目管理界面 左侧导航连接栏选择 Repos > Files ,可以查看/编辑客户端推送到服务器的 Markdown 笔记文件,支持移动端浏览器。

其他说明

  • Markdown Preview Enhanced 插件默认支持 imgur/sm.ms 图床,qiniu 图床需要首先在 qiniu 申请帐号,然后在 VSCodesettings.json 中配置以下内容:
"markdown-preview-enhanced.imageUploader": "qiniu",
"markdown-preview-enhanced.AccessKey": "..帐号实际数据..",
"markdown-preview-enhanced.SecretKey": "..帐号实际数据..",
"markdown-preview-enhanced.Bucket": "..帐号实际数据..",
"markdown-preview-enhanced.Domain": "..帐号实际数据..",
  • 可以用其他的 Markdown 编辑工具替代 VSCode,比如 TyporaVSCode 可以作为利用图床插入图片/Markdown 语法检查/与远程资料库同步等辅助工具。
  • 如果提示需要 访问令牌,请参考 Authenticate access with personal access tokens
慢读 慢生活

Slow Rhythm of Life.