MarkdownPreview 使用教程

MarkdownPreview 使用教程

MarkdownPreviewA Windows Preview handler for Markdown files项目地址:https://gitcode.com/gh_mirrors/mark/MarkdownPreview

项目介绍

MarkdownPreview 是一个用于在现代浏览器中预览 Markdown 文件的 Vim 插件。它支持跨平台（MacOS/Linux/Windows）、同步滚动、灵活配置以及使用 KaTeX 进行数学排版等功能。该插件适用于 Vim 8.1 及以上版本和 Neovim。

项目快速启动

安装

1. 使用 Vim 插件管理器安装，例如使用 vim-plug:

   Plug 'Atrejoe/MarkdownPreview'
   

2. 在 Vim 中运行 :PlugInstall 安装插件。

配置

在 .vimrc 或 init.vim 中添加以下配置：

let g:mkdp_auto_start = 0
let g:mkdp_auto_close = 1
let g:mkdp_refresh_slow = 0
let g:mkdp_command_for_global = 0
let g:mkdp_open_to_the_world = 0
let g:mkdp_open_ip = ''
let g:mkdp_browser = ''
let g:mkdp_echo_preview_url = 0
let g:mkdp_browserfunc = ''
let g:mkdp_preview_options = {
    \ 'mkit': {},
    \ 'katex': {},
    \ 'uml': {},
    \ 'maid': {},
    \ 'disable_sync_scroll': 0,
    \ 'sync_scroll_type': 'middle',
    \ 'hide_yaml_meta': 1,
    \ 'sequence_diagrams': {},
    \ 'flowchart_diagrams': {},
    \ 'content_editable': v:false,
    \ 'disable_filename': 0
    \ }
let g:mkdp_markdown_css = ''
let g:mkdp_highlight_css = ''
let g:mkdp_port = ''
let g:mkdp_page_title = '「${name}」'
let g:mkdp_filetypes = ['markdown']
let g:mkdp_theme = 'dark'

使用

在 Vim 中打开一个 Markdown 文件，然后运行以下命令：

• 启动预览：:MarkdownPreview
• 停止预览：:MarkdownPreviewStop

应用案例和最佳实践

应用案例

1. 技术文档编写：使用 MarkdownPreview 插件在浏览器中实时预览技术文档，确保格式和排版正确。
2. 博客文章编写：在编写博客文章时，使用该插件进行实时预览，提高写作效率。

最佳实践

1. 同步滚动：确保 disable_sync_scroll 设置为 0，以便在 Vim 和浏览器之间同步滚动。
2. 自定义 CSS：通过设置 g:mkdp_markdown_css 和 g:mkdp_highlight_css 来自定义预览样式。
3. 自动刷新：将 g:mkdp_refresh_slow 设置为 0，以实现快速自动刷新预览页面。

典型生态项目

1. vim-plug：用于管理 Vim 插件的插件管理器。
2. markdown-it：用于解析和渲染 Markdown 的 JavaScript 库。
3. KaTeX：用于在浏览器中进行数学排版的 JavaScript 库。
4. PlantUML：用于绘制 UML 图的工具，支持在 Markdown 中嵌入 UML 图。

通过以上内容，您可以快速上手并充分利用 MarkdownPreview 插件进行 Markdown 文件的预览和编辑。

MarkdownPreviewA Windows Preview handler for Markdown files项目地址:https://gitcode.com/gh_mirrors/mark/MarkdownPreview