在前端开发过程中，Markdown 已经成为常用的文本格式，可以用于编写文档、博客等。在 Git 上托管项目并使用 Markdown 编辑时，我们需要预览 Markdown 渲染效果。github-markdown-preview 就是一个方便的 npm 包，可以快速地在本地预览 Markdown 渲染效果。
安装 github-markdown-preview
在使用 github-markdown-preview 进行 Markdown 渲染预览前，需要先通过 npm 安装该包。打开终端（Windows 用户可以使用 Git Bash），进入项目所在的目录，输入以下命令安装 github-markdown-preview：
npm install github-markdown-preview
安装完成后，可以使用以下命令测试是否安装成功：
github-markdown-preview --version
执行该命令后，如果控制台输出 github-markdown-preview 的版本号，则说明安装成功。
使用 github-markdown-preview 进行预览
在安装成功后，可以通过一个简单的命令行命令来预览 Markdown 文件的渲染效果。以 README.md 文件为例，可以使用以下命令预览文件：
github-markdown-preview README.md
在执行该命令后，终端会自动打开浏览器，并显示 Markdown 文件渲染后的页面效果。
示例代码
-- -------------------- ---- -------
---- ---------- ---
--------- -----
----- ----------
------
----- ----------------
--------------------------------------
----- ---------------- ------------------------------------------------------------------------------------------------
-------
---- -
------- -----
-
--------
-------
----- ----------------------
--------- ----------------------------
------- -- - ---- --- ----------------------------
------- -- - ---------
----
-------- ------
-------- ------
-------- ------
-----
-------
-------# 安装依赖 npm install github-markdown-preview
# 预览 index.html 渲染效果 github-markdown-preview index.html
执行以上命令后，可以在浏览器中看到 Markdown 渲染效果。
小结
通过 npm 包 github-markdown-preview，在本地预览 Markdown 渲染效果变得更加简单。希望本文对大家有所帮助，让您在写文档、博客时更加便捷，享受 Markdown 的乐趣。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/133487