Markdown Preview for (Neo)vim 使用教程

Markdown Preview for (Neo)vim 使用教程

markdown-preview.nvimmarkdown preview plugin for (neo)vim项目地址:https://gitcode.com/gh_mirrors/ma/markdown-preview.nvim

目录结构及介绍

Markdown Preview for (Neo)vim 项目的目录结构如下：

markdown-preview.nvim/
├── app/
│   ├── ...
│   └── ...
├── autoload/
│   ├── ...
│   └── ...
├── plugin/
│   ├── ...
│   └── ...
├── src/
│   ├── ...
│   └── ...
├── test/
│   ├── ...
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── package.json
├── release.sh
├── tsconfig.json
├── tslint.json
├── yarn.lock

• app/：包含项目的主要应用程序文件。
• autoload/：包含自动加载的脚本文件。
• plugin/：包含插件的主要功能实现。
• src/：包含项目的源代码文件。
• test/：包含测试文件。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证。
• README.md：项目说明文档。
• package.json：Node.js 项目配置文件。
• release.sh：发布脚本。
• tsconfig.json：TypeScript 配置文件。
• tslint.json：TypeScript 代码风格配置文件。
• yarn.lock：Yarn 依赖锁定文件。

项目的启动文件介绍

项目的启动文件主要位于 autoload/ 和 plugin/ 目录中。以下是一些关键文件的介绍：

• autoload/mkdp.vim：插件的主要自动加载文件，包含插件的核心功能和初始化逻辑。
• plugin/markdown_preview.vim：插件的入口文件，负责加载和初始化插件。

项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。以下是这些文件的介绍：

• package.json：Node.js 项目的配置文件，包含项目的依赖、脚本命令等信息。
• tsconfig.json：TypeScript 项目的配置文件，定义 TypeScript 编译选项和项目结构。

此外，用户可以通过在 Vim 配置文件（如 .vimrc 或 init.vim）中设置以下变量来自定义插件的行为：

" 设置支持的文件类型
let g:mkdp_filetypes = ['markdown']

" 设置默认主题（dark 或 light）
let g:mkdp_theme = 'dark'

" 启用组合预览窗口
let g:mkdp_combine_preview = 0

" 自动刷新组合预览内容
let g:mkdp_combine_preview_auto_refresh = 1

通过这些配置，用户可以灵活地调整 Markdown Preview 插件的行为，以满足不同的需求。

markdown-preview.nvimmarkdown preview plugin for (neo)vim项目地址:https://gitcode.com/gh_mirrors/ma/markdown-preview.nvim