vscode-markdown-editor 开源项目使用手册

vscode-markdown-editor 开源项目使用手册

vscode-markdown-editor A vscode extension to make your vscode become a full-featured WYSIWYG markdown editor 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-markdown-editor

本手册旨在指导您了解并使用 vscode-markdown-editor，这是一个将您的 Visual Studio Code 变成功能齐全的所见即所得（WYSIWYG）Markdown 编辑器的扩展。

1. 项目目录结构及介绍

vscode-markdown-editor 的仓库遵循典型的VSCode扩展开发结构，关键组成部分包括：

• .gitignore 和 yarn.lock: 分别用于忽略不应纳入版本控制的文件以及锁定依赖版本。
• package.json: 包含扩展的基本信息如名称、版本、依赖等，并定义了扩展的操作命令。
• tsconfig.json: TypeScript编译配置文件，确保代码按预期编译。
• src 文件夹：包含了所有TypeScript源代码，是扩展的核心逻辑所在地。
  • main.ts 或类似的入口文件可能是启动编辑器功能的关键。
• settings.json 示例: 虽然不在仓库根目录默认存在，但您会在用户的设置中使用类似配置来定制化编辑器行为。
• LICENSE: 指定项目采用的MIT许可协议。
• README.md: 提供快速入门指南、特性说明和安装步骤。

2. 项目的启动文件介绍

对于终端用户而言，直接通过Visual Studio Code市场安装此扩展即可“启动”使用。无需手动处理项目内的特定启动文件。开发该扩展时，主要关注的是src/main.ts或者初始化脚本，这是扩展激活和运行的主要入口点。开发者通过VSCode的开发者模式可以运行和调试这个文件。

若需本地开发或贡献代码，通常流程是使用Node.js环境，通过npm或yarn安装依赖后，执行相关的构建或启动脚本，比如常见的yarn watch或npm run build命令，但这对普通用户不直接相关，他们仅需在VSCode内安装扩展即可开始使用。

3. 项目的配置文件介绍

用户端配置

• 在您安装vscode-markdown-editor后，可以通过修改VSCode的settings.json来个性化编辑器的行为。例如，添加或修改 "markdown-editor.customCss" 来注入自定义CSS规则，改变编辑器的布局或样式。

  "markdown-editor.customCss": ".vditor-ir pre.vditor-reset { line-height: 32px; padding-right: calc(100% - 800px); important; margin-left: 100px; font-family: system-ui; important; }"
  

开发者配置

• 对于开发者来说，主要配置位于项目根目录的package.json，它不仅指定依赖项，还定义了构建流程、脚本命令等。
• 若需调整编译选项或开发环境配置，则还需查看tsconfig.json文件。

通过上述指引，无论是使用者还是潜在的贡献者，都能对vscode-markdown-editor有一个基本的理解，从而更加高效地利用或开发这一工具。

vscode-markdown-editor A vscode extension to make your vscode become a full-featured WYSIWYG markdown editor 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-markdown-editor