VSCode Markdown 插件使用教程
vscode-markdown项目地址:https://gitcode.com/gh_mirrors/vsc/vscode-markdown
1. 项目的目录结构及介绍
vscode-markdown/
├── .github/
│ └── workflows/
│ └── ci.yml
├── images/
│ └── example.png
├── src/
│ ├── commands/
│ │ ├── index.ts
│ │ └── ...
│ ├── preview/
│ │ ├── index.ts
│ │ └── ...
│ ├── test/
│ │ ├── index.ts
│ │ └── ...
│ ├── extension.ts
│ └── package.json
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json
- .github/workflows/: 包含GitHub Actions的工作流配置文件。
- images/: 存放项目中使用的图片资源。
- src/: 项目的源代码目录。
- commands/: 包含插件的命令实现。
- preview/: 包含预览功能的实现。
- test/: 包含测试代码。
- extension.ts: 插件的主入口文件。
- .gitignore: Git忽略文件配置。
- .vscodeignore: VSCode忽略文件配置。
- CHANGELOG.md: 项目更新日志。
- LICENSE: 项目许可证。
- package.json: 项目的npm配置文件,包含依赖和脚本。
- README.md: 项目说明文档。
- tsconfig.json: TypeScript配置文件。
2. 项目的启动文件介绍
项目的启动文件是 src/extension.ts
。这个文件是插件的入口点,负责初始化插件并注册命令。以下是 extension.ts
的主要内容:
import * as vscode from 'vscode';
import { activateCommands } from './commands';
import { activatePreview } from './preview';
export function activate(context: vscode.ExtensionContext) {
activateCommands(context);
activatePreview(context);
}
export function deactivate() {}
- activate: 插件激活时调用的函数,负责初始化和注册命令。
- deactivate: 插件停用时调用的函数。
3. 项目的配置文件介绍
项目的配置文件主要是 package.json
。这个文件包含了插件的所有元数据、依赖和命令配置。以下是 package.json
的部分内容:
{
"name": "vscode-markdown",
"displayName": "Markdown All in One",
"description": "All you need to write Markdown (keyboard shortcuts, table of contents, auto preview and more)",
"version": "3.4.0",
"publisher": "yzhang",
"engines": {
"vscode": "^1.52.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onLanguage:markdown"
],
"main": "./src/extension.ts",
"contributes": {
"commands": [
{
"command": "markdown.extension.onSave",
"title": "Save Markdown"
}
]
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"pretest": "npm run compile && npm run lint",
"lint": "eslint src --ext ts",
"test": "node ./out/test/runTest.js"
},
"devDependencies": {
"@types/vscode": "^1.52.0",
"@types/glob": "^7.1.3",
"@types/mocha": "^8.2.0",
"@types/node": "^12.11.7",
"eslint": "^7.19.0",
"glob": "^7.1.6",
"mocha": "^8.2.1",
"typescript": "^4.1.3",
"vscode-test": "^1.5.0"
}
}
- name:
vscode-markdown项目地址:https://gitcode.com/gh_mirrors/vsc/vscode-markdown