VSCode Markdown 插件使用教程

1. 项目的目录结构及介绍

目录结构

vscode-markdown/
├── .github/
│   └── workflows/
├── assets/
├── src/
│   ├── commands/
│   ├── helpers/
│   ├── languages/
│   ├── preview/
│   ├── toc/
│   └── utils/
├── test/
│   ├── commands/
│   ├── helpers/
│   ├── languages/
│   ├── preview/
│   ├── toc/
│   └── utils/
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── webpack.config.js

目录介绍

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• assets: 包含项目所需的静态资源文件。
• src: 包含插件的主要源代码。
  • commands: 包含插件的命令实现。
  • helpers: 包含辅助函数和工具类。
  • languages: 包含语言相关的处理逻辑。
  • preview: 包含预览相关的处理逻辑。
  • toc: 包含目录生成相关的处理逻辑。
  • utils: 包含通用工具函数。
• test: 包含单元测试和集成测试代码。
• .gitignore: 指定Git忽略的文件和目录。
• .vscodeignore: 指定在打包插件时忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的许可证。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的介绍和使用说明。
• tsconfig.json: TypeScript的配置文件。
• webpack.config.js: Webpack的配置文件。

2. 项目的启动文件介绍

启动文件

项目的启动文件主要是src/extension.ts，它是插件的入口点。

启动文件介绍

src/extension.ts 文件负责注册插件的命令和事件监听器。它导入了其他模块中的命令实现，并在插件激活时注册这些命令。

import * as vscode from 'vscode';
import { registerCommands } from './commands';

export function activate(context: vscode.ExtensionContext) {
    registerCommands(context);
}

export function deactivate() {}

3. 项目的配置文件介绍

配置文件

项目的配置文件主要是package.json，它包含了插件的元数据、依赖、命令和配置项。

配置文件介绍

package.json 文件的关键部分包括：

• name: 插件的名称。
• version: 插件的版本号。
• publisher: 插件的发布者。
• engines: 插件支持的VS Code版本。
• activationEvents: 插件的激活事件。
• contributes: 插件的贡献点，包括命令、快捷键、配置项等。
• dependencies: 插件的依赖包。

{
  "name": "vscode-markdown",
  "version": "3.4.0",
  "publisher": "yzhang",
  "engines": {
    "vscode": "^1.52.0"
  },
  "activationEvents": [
    "onLanguage:markdown"
  ],
  "contributes": {
    "commands": [
      {
        "command": "markdown.extension.onSave",
        "title": "Markdown: Save without formatting"
      }
    ],
    "configuration": {
      "type": "object",
      "title": "Markdown",
      "properties": {
        "markdown.extension.toc.levels": {
          "type": "string",
          "default": "2..6",
          "description": "Toc levels to show"
        }
      }
    }
  },
  "dependencies": {
    "vscode-languageclient": "^7.0.0"
  }
}

通过以上介绍，您可以更好地理解和使用yzhang-gh/vscode-markdown插件。希望这份教程对您有所帮助！