npm 包 harb-org 使用教程

简介

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


猜你喜欢

  • npm 包 frkskyweb 使用教程

    介绍 frkskyweb 是一款基于 Vue.js 的 UI 组件库,它具有高度可定制的特点,不仅提供了一些基础组件,还提供了丰富的样式和功能组件,非常方便前端开发人员快速搭建漂亮的界面。

    2 年前
  • npm 包 babel-preset-es2015-ie-native-modules 使用教程

    随着前端技术的发展,越来越多的开发者开始使用 ES6 语法。然而,由于不同浏览器对 ES6 语法支持不同,有些浏览器只支持 ES5 语法,这就导致了开发者需要对代码进行转换,以确保代码能够在各种浏览器...

    2 年前
  • npm 包 sequelize-paper-trail-scalio 使用教程

    简介 sequelize-paper-trail-scalio 是一个用于 Sequelize ORM 的数据库历史版本管理工具。它可以记录每次数据库操作的修改历史,并提供查询历史记录的接口,以便于追...

    2 年前
  • npm 包 cooking-apicloud-command 使用教程

    在前端开发中,常常需要使用一些工具来提高开发效率和代码质量。而 npm 包成为了前端开发者们最常使用的工具,其中 cooking-apicloud-command 是一个非常实用的 npm 包,它可以...

    2 年前
  • npm 包 ng-auto-validate 使用教程

    前言 在前端开发中,表单验证是必不可少的一个环节。有时候为了达到好的用户体验,我们需要在用户填写的时候及时提醒其填写错误的地方,这就需要我们用到动态验证。ng-auto-validate 是一个 An...

    2 年前
  • npm 包 extplug-autowoot 使用教程

    如果你在开发扩展插件或用户脚本的时候需要自动点赞功能,那么 extplug-autowoot 这个 npm 包会非常方便。它可以在插件中自动化处理点赞并提供额外的 API。

    2 年前
  • npm 包 extplug-chat-images 使用教程

    在前端开发中,我们经常需要在页面中展示图片。而当我们需要在聊天室等交互场景中进行图片展示时,我们通常需要借助一些工具来实现。extplug-chat-images 就是一个解决聊天室图片展示问题的 n...

    2 年前
  • npm 包 ui-listview 使用教程

    介绍 ui-listview 是一个基于 React 开发的可定制列表组件。它可以帮助开发者快速构建美观、高度定制化的列表,例如产品分类、商品列表、购物车等。 安装 您可以通过 npm 安装 ui-l...

    2 年前
  • npm 包 auv 使用教程

    介绍 AUV (Another Utility Library) 是一个轻量级的 JavaScript 工具库,它包含了大量的实用方法和函数,简化了前端开发的许多操作。

    2 年前
  • npm 包 kayo 使用教程

    简介 kayo 是一个基于 React 的组件库,提供了一些常用的 UI 组件,如按钮、表单、弹窗、抽屉等。使用 kayo 可以快速开发一个漂亮的前端界面,提高开发效率。

    2 年前
  • npm 包 machete-framework 使用教程

    在前端开发中,怎么能少得了不同的框架和工具呢?而其中一个不可或缺的工具就是 npm 包。在本篇文章中,我们将会介绍一个常用的 npm 包,即 machete-framework。

    2 年前
  • NPM 包 zonk 使用教程

    简介 zonk 是一款能够帮助前端工程师更好地处理错误的工具,它支持按照指定的条件对错误信息进行处理、上报和分析。这个工具的价值在于,能够让我们更迅速地找到问题并解决问题,从而提高开发效率。

    2 年前
  • npm 包 angular-terminal 使用教程

    介绍 angular-terminal 是一个基于 Angular 框架开发的命令行终端,它提供了一个交互式的 UI 界面,让用户可以像操作命令行一样在网页上使用一些基本的命令,如 ls 、cd、 m...

    2 年前
  • npm 包 inferno-datatable 使用教程

    在前端开发过程中,表格是一个非常常见的组件,而如何快速地构建出一个表格通常是一个必须要解决的问题。inferno-datatable 是一个使用 Inferno 框架开发的表格组件,它可以通过 npm...

    2 年前
  • npm 包 react-view-controller 使用教程

    react-view-controller 是一款 React 组件库,它提供了一个可插拔的页面视图控制器,使得开发者可以更加便捷地管理和切换不同的页面视图。 在本篇文章中,我们将会详细介绍 reac...

    2 年前
  • NPM 包 27MHz 使用教程

    在前端开发中,我们经常会使用各种 NPM 包来辅助我们开发。今天我们要介绍的就是一个名叫 27MHz 的 NPM 包。 什么是 27MHz 27MHz 是一个用于前端开发的 NPM 包。

    2 年前
  • npm包 node-js-info-bubble 使用教程

    什么是node-js-info-bubble? node-js-info-bubble是一个基于Node.js的开源JavaScript库,它可以为网页中的元素弹出带有提示信息的气泡。

    2 年前
  • npm 包 mit-city-select 使用教程

    前言 现今,在前端开发中,好的工具包可以极大地提高工作效率。而 npm 包 mit-city-select 就是一款优秀的地区选择插件,它支持多种场景下的使用,可以帮助前端工程师快速构建地区选择功能。

    2 年前
  • npm 包 grunt-gen-dpdjs 使用教程

    前言 Node.js 是现在前端领域非常流行的技术,它可以让我们开发出高效、稳定的 web 应用。而 npm 包则是 Node.js 世界的核心元素之一,它可以帮助我们在自己的项目中高效地管理和使用各...

    2 年前
  • npm 包 react-page-layers 使用教程

    前言 React 是一个快速流行的前端框架,它让开发者更加方便快捷地构建复杂的 Web 应用程序。而 npm 是 JavaScript 包的默认包管理器,它可以轻松获取各种开源的 JavaScript...

    2 年前

相关推荐

    暂无文章