npm 包 @mtscout6/markserv 使用教程

阅读时长 3 分钟读完

前言

如果你是一个前端开发人员,你一定知道在开发网站的过程中,经常需要使用到 Markdown 文件进行说明文档的编辑。

那么问题来了,如何方便地将 Markdown 文件转换成 HTML 呈现在浏览器上呢?

这个时候,@mtscout6/markserv 就派上用场了。

@mtscout6/markserv 是一款基于 Node.js 的命令行工具,能够将 Markdown 文件实时转换为漂亮的 HTML 页面并且支持自动刷新。

本篇文章就是一份详细的使用教程,帮助你快速上手使用 @mtscout6/markserv 。

安装

@mtscout6/markserv 是一款基于 Node.js 的命令行工具, 因此需要先安装 Node.js 环境和 NPM 包管理工具。

安装完成后,运行以下命令进行 @mtscout6/markserv 安装:

使用

基础用法

安装完成之后,我们来看一下如何使用。

首先,在命令行中输入以下命令:

这时 @mtscout6/markserv 就开始工作了,它会查找当前目录下的 markdown 文件并且转换为 HTML 并且支持自动刷新。

指定端口

默认情况下,@mtscout6/markserv 会使用 8080 端口,如果需要修改端口号的话,可以通过以下方式:

这时,@mtscout6/markserv 就会使用端口号为 3000 的端口启动。

指定根目录

默认情况下,@mtscout6/markserv 会以当前目录为根目录展示,如果需要指定根目录,则可以通过以下方式:

这时,@mtscout6/markserv 就会以 ~/Documents 目录作为根目录启动。

指定文件

默认情况下,@mtscout6/markserv 会查找当前目录下的所有 markdown 文件进行转换,如果需要查看某个特定的文件,则可以通过以下方式:

这时,@mtscout6/markserv 就会将 README.md 文件转化为 HTML 并以当前目录为根目录启动。

支持实时刷新

除了以上功能,@mtscout6/markserv 能够支持实时刷新。在你编辑保存 Markdown 文件的同时,它会自动进行实时刷新实现无需手动刷新浏览器的便利。

结束语

通过上述教程,我们详细了解了 @mtscout6/markserv 的使用和功能,希望这篇文章能够对你的学习和工作有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e24483d

纠错
反馈