npm 包 Wrigley 使用教程

阅读时长 4 分钟读完

Wrigley 是一个基于 Node.js 的轻量级静态网站生成器,可以快速地将 Markdown 文件转换为 HTML 页面,并生成相应的资源文件(如样式表和 JavaScript 文件)。本篇文章将详细介绍 Wrigley 的安装、配置和使用方法,并提供示例代码辅助读者快速上手。

1. 安装 Wrigley

Wrigley 是一个 npm 包,因此需要先安装 Node.js 和 npm。在安装完成后,可以在命令行中输入以下命令来安装 Wrigley:

安装完成后,可以使用以下命令来检查 Wrigley 是否已成功安装:

如果能够成功输出 Wrigley 的版本号,则说明安装成功。

2. 配置 Wrigley

Wrigley 的配置文件为 wrigley.json,默认情况下会在当前工作目录下寻找该文件。如果需要指定具体的配置文件,可以在命令行中使用 -c 或 --config 参数来指定。以下是一个基本的 wrigley.json 配置文件示例:

-- -------------------- ---- -------
-
  -------- ------
  --------- -------
  --------- ---------
  ---------- ----
  -------- --- ------- ------
  -------------- ----- -- -- ------- -------
  ----------- -------------
-
  • input:源文件所在目录。默认为 src。
  • output:生成的静态文件所在目录。默认为 dist。
  • assets:静态资源所在目录。默认为 assets。
  • baseUrl:站点的根 URL。默认为 /。
  • title:站点的标题。默认为 Wrigley。
  • description:站点的描述。默认为空。
  • template:HTML 模板文件的路径。默认为 layout.html。

3. 使用 Wrigley

在配置好 Wrigley 后,即可使用以下命令来生成静态网站:

该命令会在配置文件中指定的 output 目录下生成静态 HTML 文件和相应的资源文件。

如果需要在开发过程中自动刷新生成的 HTML 文件,可以使用以下命令:

该命令会在本地启动一个 Web 服务器,并监听指定的端口(默认为 8000)。每当输入文件发生变化时,Wrigley 会自动重新生成 HTML 文件并刷新浏览器。

4. 示例代码

以下是一个简单的示例,演示了如何使用 Wrigley 生成一个基本的静态网站。

Step 1:创建目录并进入

Step 2:安装 Wrigley

Step 3:创建源文件目录

Step 4:创建 Markdown 文件

Step 5:创建 HTML 模板文件

Step 6:创建配置文件

Step 7:生成静态网站

现在在目录下就会生成一个 dist 目录,其中包含一个 index.html 文件。您可以在浏览器中打开该文件,查看生成的效果。

总结:

通过本篇文章的介绍,我们学习了 Wrigley 的安装、配置和使用方法,并用示例代码演示了如何使用 Wrigley 生成一个基本的静态网站。Wrigley 的简单易用使得它成为了一个很好的静态网站生成器,特别是适用于个人博客等小型站点的搭建。

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

纠错
反馈