npm 包 mdpages 使用教程

简介

mdpages 是 Node.js 上一款处理 markdown 文档的工具，它能够自动解析项目中的 markdown 文件，并将其转换为一个静态网站。mdpages 能够帮助前端开发者快速地搭建一个基于 markdown 文档的静态网站，同时支持多种自定义配置。

安装

使用 npm 安装 mdpages:

$ npm install -g mdpages

安装成功后，你就可以使用 mdpages 命令了。

命令

初始化

在项目目录下运行以下命令，生成配置文件与样式文件：

$ mdpages init

生成的文件包含：

• .mdpagesrc - mdpages 的配置文件，可以自定义配置 mdpages 的一些参数。
• .mdpages - mdpages 的模板样式文件。
• ._config.yml - Jekyll 的配置文件，用于配置 GitHub Pages 中的 Jekyll 主题。

构建

执行以下命令可以将 markdown 文件转换为静态网站：

$ mdpages build

构建完成后在目录下存在 _site 目录，里面包含了生成的静态页面和资源文件。

预览

构建命令不会启动 web 服务器，如果想要在本地预览生成的静态网站，可以执行以下命令：

$ mdpages serve

执行上述命令后，在本地 4000 端口启动一个服务器，然后在浏览器中访问 http://localhost:4000 即可预览生成的静态网站。

配置

mdpages 的配置文件是 .mdpagesrc 文件，支持以下配置项：

baseurl

类型：string

默认：/

指定生成的静态网站的路径。

author

类型：string

默认：null

指定网站的作者。

title

类型：string

默认：null

指定网站的标题。

description

类型：string

默认：null

指定网站的描述信息。

markdown

类型：object

默认：{}

用于配置 markdown 规则。

markdown: {
    html: true,
    linkify: false,
    typographer: false
}

ignore

类型：array

默认：[]

忽略的文件和目录，支持 glob 语法。

ignore: ['*.tmp', '_*", .DS_Store']

示例代码

以下是一个简单的示例代码：

$ mdpages init
$ mdpages build
$ mdpages serve

以上命令将生成一个具有默认样式的静态网站，并在本地 4000 端口启动一个服务器以便于预览。

总结

mdpagers 是一款非常实用的工具，它可以为前端开发者快速搭建一个基于 markdown 文档的静态网站。借助于 mdpagers 强大的自定义配置功能，用户能够轻松地制定个性化的静态网站。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f72062ca9b7065299ccbb99