VMD 项目使用教程

VMD 项目使用教程

【免费下载链接】vmd :pray: preview markdown files 项目地址: https://gitcode.com/gh_mirrors/vm/vmd

1. 项目介绍

VMD 是一个用于预览 Markdown 文件的工具，它能够在单独的窗口中以 GitHub 风格渲染 Markdown 内容。VMD 支持文件监视、标准输入、拖放操作、页面内导航、剪贴板操作、表情符号显示、检查列表渲染、页面内搜索、自定义主题和前言渲染等功能。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm。然后，通过以下命令全局安装 VMD：

npm install -g vmd

使用

安装完成后，你可以通过以下命令启动 VMD：

vmd [FILE] [OPTIONS]

例如，预览一个名为 README.md 的文件：

vmd README.md

如果没有指定文件，VMD 会默认查找当前目录下的 README.md 文件。

常用选项

• -v, --version: 显示版本号
• -h, --help: 显示使用说明
• -d, --devtools: 打开开发者工具
• -z, --zoom=NUM: 设置缩放因子
• --document=FILENAME: 指定默认打开的文件名

3. 应用案例和最佳实践

案例1：实时预览 Markdown 文件

在编写 Markdown 文档时，VMD 可以实时监视文件变化并自动更新预览窗口，非常适合在文本编辑器中编写文档时使用。

案例2：通过标准输入预览 Markdown

你可以通过管道将其他程序的输出直接传递给 VMD 进行预览：

cat README.md | vmd

最佳实践

• 自定义样式：通过 --styles-main 和 --styles-extra 选项，你可以自定义 VMD 的样式，使其更符合你的需求。
• 使用前言渲染：VMD 支持 YAML、TOML 和 JSON 格式的前言渲染，可以通过 --frontmatter-formats 和 --frontmatter-renderer 选项进行配置。

4. 典型生态项目

VMD 作为一个 Markdown 预览工具，可以与以下项目结合使用：

• 文本编辑器：如 VSCode、Sublime Text 等，可以在编辑器中实时预览 Markdown 文件。
• 文档生成工具：如 Jekyll、Hugo 等，VMD 可以预览这些工具生成的 Markdown 文件。
• 版本控制系统：如 Git，VMD 可以预览 Git 仓库中的 Markdown 文件。

通过这些生态项目的结合，VMD 能够更好地服务于开发者，提升文档编写和预览的效率。

【免费下载链接】vmd :pray: preview markdown files 项目地址: https://gitcode.com/gh_mirrors/vm/vmd