npm 包 metalsmith-handlebars-within 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

简介

metalsmith-handlebars-within 是一个 npm 包,它是 metalsmith 和 handlebars 的结合体。它提供了一种简单且有效的方式来处理静态网站的生成。

metalsmith 是一个简单且易于使用的静态站点生成器,它使用 node.js 来自动构建一个静态的网站。metalsmith 可以方便地管理内容和整个企业站点。而 handlebars 是一个强大的模板引擎,它可以帮助我们构建出美观的 web 页面。

metalsmith-handlebars-within 利用了这两个工具的优点来生成静态网站。它提供了一种强大且易用的方式来处理网站生成的过程,同时也保留了与现有文件结构一致性的简单性。

使用教程

安装

使用 npm 在终端中输入以下命令来安装 metalsmith-handlebars-within:

--- ------- ---------------------------- ----------

建立文件夹结构

首先,我们需要建立一个文件夹作为我们的静态网站的根目录。然后,在该文件夹中创建以下结构:

-----
--- ----
-   -- ---------
--- ----
-   -- ---------
--- ---
-   -- ----------
--- ----
--- --------
--- -----------

其中,src 文件夹存放我们的 handlebars 模板文件,css 文件夹存放我们的 css 文件,js 文件夹存放我们的 JavaScript 文件,img 文件夹存放我们的图片。

index.md 文件是我们的内容文件,config.json 文件是我们的配置文件。这些文件及其作用将在后文中详细讲解。

配置

在开始使用 metalsmith-handlebars-within 之前,我们需要配置一些参数。我们的配置文件 config.json 如下:

-
  --------- ------
  -------------- --------
  ------------ --------------
  -------------- ---------------
  ------------- --------------
  ----------- ---
  -------------- ---
  ------------- -
    -
      ------- -------
      ------ ---
    -
  --
  --------- ---
  -------- -----
  ----------- -----
  ------ ------
  ------- -----
  ------- -----
  -------- -----
  ------------- -
    -------- -----
  -
-

其中,各参数的作用如下:

  • source:源文件夹路径。
  • destination:生成的静态网站存储的文件夹路径。
  • layoutDir:handlebars 布局文件夹路径。
  • partialsDir:handlebars 片段文件夹路径。
  • helpersDir:handlebars 帮助函数文件夹路径。
  • metadata:元数据。
  • collections:文档集合。
  • navigation:网站导航。
  • ignore:要忽略的文件夹路径。
  • clean:是否清除目标文件夹。
  • relative:生成站点时是否使用相对路径。
  • dev:是否处于开发模式。
  • port:服务器端口。
  • open:是否自动打开浏览器。
  • watch:是否监视文件更改。
  • browserify:Browserify 配置。

创建 index.hbs 文件

接下来,我们需要创建 index.hbs 文件。打开 src 文件夹,在其中创建名为 index.hbs 的文件:

--------- -----
----- ----------
  ------
    ----- ----------------
    ------------------------
    ----- ---------------- ----------------------
    ------- -------------------- ---------------
  -------
  ------
    --------
      ------- ------------
        -- ---------------------------
      ---------
    ---------
    ------
      -------------
    -------
    --------
      ------ -------- -- ------- ----
    ---------
  -------
-------

这是我们的 index 应用程序的主要布局。它包含了一个换完了自视口标签和我们所需的脚本和样式引用。此外,它还包含一个顶部导航和一个页脚。页面的主要内容被插入到 {{{content}}} 中。

创建 index.md 文件

接下来,我们需要创建 index.md 文件。打开根目录,在其中创建名为 index.md 的文件:

---
------ -- ------- ----
---

- ------ ------

------- -- -- ------- -----

该文件中包含了我们的独立标记格式语法的主要内容。其中包括页面的标题和我们的 Markdown 中的实际内容。

运行 metalsmith-handlebars-within

最后,我们需要运行 metalsmith-handlebars-within

在终端中输入以下命令:

--- ----------

然后打开浏览器,在 http://localhost:8080/ 查看你的站点即可。

总结

metalsmith-handlebars-within 是一个非常强大的 npm 包,它结合了 metalsmith 和 handlebars 的优点,可以让我们更加方便地处理静态网站的生成。本文详细介绍了使用该包的过程,希望能对大家有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066f3f1d8e776d08040bd0


猜你喜欢

  • npm 包 mincer-jsx 使用教程

    如果你是一位前端开发者,可能已经听说过 npm。npm(Node.js 包管理器)是 JavaScript 的包管理工具,允许开发者在 JavaScript 应用程序中共享代码和工具。

    4 年前
  • npm包 mincer-ractive 使用教程

    介绍 mincer-ractive是一个基于Mincer和Ractive的前端组件包。Mincer为我们提供了处理和编译前端资源的能力,比如LESS和CoffeeScript,而Ractive则是一个...

    4 年前
  • npm 包 mincolor 使用教程

    前言 在前端开发中,我们通常需要处理颜色值,包括生成颜色、比较颜色、计算色彩等。在这个过程中,我们需要使用专业的工具和库来帮助我们更好地完成这些任务。其中,mincolor 是一个优秀的 npm 包,...

    4 年前
  • npm 包 mincer-ruby-sass 使用教程

    前言 在前端开发中,样式表的处理是必不可少的一项工作。我们通常使用 Sass 进行 CSS 预处理,通过运行 Sass 编译器将 Sass 代码转换为 CSS 代码。

    4 年前
  • npm 包 midi-message 使用教程

    MIDI(音乐仪器数字接口)是一种数字音频技术,允许硬件和软件设备之间传输音频信息。MIDI 信息通常由三个部分组成:状态字节、数据字节 1 和数据字节 2。npm 包 midi-message 就是...

    4 年前
  • npm 包 midi-node 使用教程

    在音乐制作软件中,MIDI 是一种广泛使用的数字音频接口协议。npm 包 midi-node 提供了一个简单的方法来读写 MIDI 文件,使得在 Node.js 环境中使用 MIDI 数据变得容易。

    4 年前
  • npm 包 midi-note 使用教程

    在音乐制作和音乐教育中,我们经常需要将 MIDI 笔记转换为更人性化的音符名称,比如将 MIDI 笔记 60 转换为 C4。npm 包 midi-note 就是一个用来方便进行这种 MIDI 笔记和音...

    4 年前
  • npm包midi-param-util使用教程

    在前端开发中,我们经常使用到npm(Node Package Manager)包来管理依赖。其中有一款被广泛使用的npm包叫做midi-param-util,它提供了一种方便的方法来处理MIDI参数。

    4 年前
  • npm 包 midi-pitches 使用教程

    在前端开发中,有时会涉及到处理音频相关的需求,而midi-pitches正是一个有用的npm包,可以帮助你更方便地进行音频处理的操作。本文将为大家介绍如何使用该包。

    4 年前
  • npm 包 mimemap 使用教程

    在前端开发中,经常需要处理各种类型的文件。而不同类型的文件需要采用不同的方式进行处理,因此识别文件类型就显得非常重要。npm 包 mimemap 就提供了一种方便快捷的方式来识别文件类型,以下是具体的...

    4 年前
  • npm 包 midi-port-holder 使用教程

    在前端开发中,有时我们需要使用 MIDI(Musical Instrument Digital Interface)接口来控制音乐设备或者生成音乐。而 npm 包 midi-port-holder 则...

    4 年前
  • npm 包 midi-sounds-react 使用教程

    介绍 midi-sounds-react 是一个基于 React 的 MIDI 声音播放组件,由 Web MIDI API 提供支持,可以播放 MIDI 文件。它支持在 React 应用程序中播放 M...

    4 年前
  • npm 包 midi-stream 使用教程

    MIDI 是一种数字音频接口标准,它允许电子乐器、计算机和其他设备之间进行通信。而 midi-stream 是一个流式处理 MIDI 数据的 Node.js 模块。

    4 年前
  • npm 包 midi-synth 使用教程

    midi-synth 是一款用于生成 MIDI 音乐的 npm 包,可以使用它来创建新音乐或者将现有 MIDI 文件进行修改和修改。在本教程中,我们将深入学习如何使用 midi-synth 去搭建一个...

    4 年前
  • npm 包 midi-timing 使用教程

    在前端领域中,音乐播放器经常被使用。而就音乐播放器而言,在播放 MIDI 文件时,定时控制成为了一项必备任务。npm 包 midi-timing,正是为了解决这个问题而设计的。

    4 年前
  • npm包midi-qwerty-keys使用教程

    在前端应用中,音频功能越来越常见。在实现键盘演奏功能时,使用MIDI键盘是非常方便的。但是,在测试和演示音频应用时,MIDI设备并不总是可用的。因此,使用计算机键盘模拟MIDI设备是非常有帮助的。

    4 年前
  • npm 包 midi-ports 使用教程

    本文将介绍如何使用 npm 包 midi-ports 来在浏览器中获取 MIDI 输入和输出端口。MIDI(Musical Instrument Digital Interface)是一种音频技术,可...

    4 年前
  • npm 包 mimeparser 使用教程

    前言 在前端开发中,我们经常需要处理文件上传、下载、解析等任务。其中,文件类型的解析是一个不可或缺的环节,而 mimeparser 包正是为此而生。 本文将从以下几个方面介绍 npm 包 mimepa...

    4 年前
  • npm 包 mimemessage 使用教程

    在前端开发中,我们经常需要发送电子邮件,而 mimemessage 就是一款 npm 包,可以让我们在前端中方便的构建和发送符合 RFC 5322 格式的邮件。 安装 mimemessage 使用 n...

    4 年前
  • npm 包 mimes 使用教程

    简介 npm 包 mimes 是一个用于获取文件 MIME 类型的工具,它可以帮助前端开发者判断文件类型并使用相应的处理方法。该工具支持多种文件格式的 MIME 类型获取,如图片、视频、音频、文本等。

    4 年前

相关推荐

    暂无文章