npm 包 harb-org 使用教程

阅读时长 3 分钟读完

简介

harp-org 是一个基于 Harp.js 和 Markdown 的静态站点生成器,可用于构建简单的静态网站。它提供了一些简单的编写方式和快速构建功能,可以轻松地将 Markdown 文件转换成静态网站。

安装

在使用 harb-org 之前,需要安装 Node.jsnpm。安装完成后,在终端中执行以下命令:

使用

在安装了 harb-org 后,我们可以使用以下命令创建一个新的静态网站:

上面的命令会在当前目录下创建一个名为 my_website 的文件夹,并启动一个本地服务器,可以在浏览器中访问 http://localhost:9000 来查看网站。在本地服务器运行期间,每次更改任何文件时,网站都会自动重新加载。

目录结构

harb-org 生成的网站结构如下所示:

-- -------------------- ---- -------
- ------
  - ----------
- ----------
  - --------
  - ----------
  - ----------
- ---------
  - -----------
- ---------
  - -------
- --------
  - ---------
- ------
  - ---------
- ---------
  • _data 目录用于存储数据文件,可以在视图中使用。
  • _includes 目录包含用于生成页面的可重复组件。
  • _layouts 目录包含用于生成页面的布局文件。
  • _scripts 目录包含用于网站的 JavaScript 文件。
  • _styles 目录包含用于网站的样式文件。
  • about 目录是自定义页面的示例,其中包含了一个 index.ejs 文件。

写作

在创建了我们的网站之后,我们需要为网站撰写内容。在 harb-org 中,我们可以使用 Markdown 编写内容。Markdown 是一种轻量级的标记语言,可以将普通文本转换为 HTML。

编写内容时,可以创建新的 Markdown 文件并将其保存到 public 目录中。参考以下示例:

title 属性用于设置页面的标题,可以在页面头部添加其他元数据。

构建

当网站准备就绪时,可以使用以下命令构建网站:

上面的命令将把 public 目录中的所有文件编译成 HTML、CSS 和 JavaScript,并将其保存到 www 目录中。现在,可以将 www 目录中的内容部署到 Web 服务器上。

结论

使用 harb-org 可以轻松地构建一个简单的静态网站,提供了一些简单的编写方式和快速构建功能,可以轻松地将 Markdown 文件转换成静态网站。在使用中,您可以根据需要进行自定义,并在构建之后将其部署到 Web 服务器上。

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

纠错
反馈