0%

Markdown入门

1. Markdown 简介

Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

Markdown 具有一系列衍生版本,用于扩展 Markdown 的功能(如表格、脚注、内嵌HTML等等),这些功能原初的 Markdown 尚不具备,它们能让 Markdown 转换成更多的格式,例如LaTeX,Docbook。

Markdown 增强版中比较有名的有 Markdown Extra、MultiMarkdown、 Maruku 等。这些衍生版本要么基于工具,如 Pandoc;要么基于网站,如 GitHub 和 Wikipedia ,在语法上基本兼容,但在一些语法和渲染效果上有改动。

2. 使用的 IDE

2.1 typora

官网地址https://typora.io/

2.2 VSCode

2.2.1 软件下载

官网地址https://code.visualstudio.com/

2.2.2 安装插件

更改 VSCode 语言

  • Chinese (Simplified) Language Pack for Visual Studio Code

Markdown 相关

  • Foam for VSCode (Wikilinks to Markdown)
  • Markdown All in One
  • Markdown Notes
  • Markdown Preview Enhanced
  • markdown-formatter
  • Markdown+Math
  • Markdown Links :markdown 的脑图使用,选装

2.2.3 环境配置

Shift + Ctrl + P 调出命令框,输入 Setting 点开设置页面,将以下代码复制对其进行更新

1
2
3
4
5
6
7
8
9
{
......(该处是之前的设置)

"window.zoomLevel": 0,

"[markdown]": {
"editor.quickSuggestions": true
},
}
  • 这段是打开 markdown 的代码提示

3. Markdown 语法入门

参考文档

3.1 图片设置

4. 更改设置代码块提示

  1. Shift + Ctrl + P 调出命令框

  2. 输入 Snippets 点开代码提示设置页面

  3. 选中 markdown.json 并打开

以输入 js 代码片段为例,在这个 json 文件中添加如下代码:

1
2
3
4
5
6
7
8
9
10
11
{
"code js": {
"prefix": "js",
"body": [
"```js",
"$0",
"```"
],
"description": "output js"
},
}
属 性 含 义
name “code js” 代码片段名称
prefix 用来触发代码段的内容
body 生成的代码片段的内容,注意数组形式
$0 最后的光标位置
${1:label}, ${2:another} 占位符,具有相同 ID 的占位符被链接
description 片代码段描述

5. Markdown Links 入门

5.1 工作流程

推荐的工作流程是保持图形处于打开状态,并将其用作资源管理器侧边栏的替代方法,或者不时检查它。

每次您执行以下操作时,图形都会自动刷新:

  • 更新文件的 Markdown 标题。
  • 更改到其他文件的链接。
  • 创建一个新文件并添加标题。
  • 删除文件。
  • 当编辑器中的活动文件更改且与图中的文件之一匹配时,它将突出显示。

5.2 概念

  • 标题始终是深度1的第一个 Markdown 标题,即 标题。
  • 没有标题的文件不会出现在图形中。
  • 文件可以使用本地 Markdown 链接,基于 ID 的链接或 [文件名] 链接链接到其他文件。
  • 该图没有方向。它不显示哪个文件具有链接,哪个链接。
  • 目录结构与图无关。重要的是文件之间的相互链接。

5.3 用例

1
2
3
4
5
6
7
8
9
# 标题

## 链接

-[第二](https://github.com/tchayen/markdown-links/blob/master/./2.md)

也可以使用命名参考,例如:[Reference].

[reference]: ref.md

5.4 设定值

此扩展提供以下设置:

  • markdown-links.showColumn
    控制图形应出现在哪一列。请参阅列值。默认为旁边。
     
  • markdown-links.openColumn
    控制应在哪个列中单击文件。请参阅列值。默认为1。

5.5 列值

  • 有效–在当前关注的列中。
  • 除了当前以外。
  • one (default), two, three, four, five, six, seven, eight, nine – 分别为编辑器列。
     
  • markdown-links.fileIdRegexp
    用于查找要在Wiki样式的链接中使用的文件ID的正则表达式。
     
  • markdown-links.graphType
    • default (default)
    • obsidian - obsidian like graph