npm 包 metalsmith-push 使用教程

阅读时长 5 分钟读完

在前端开发中,构建工具是不可或缺的。Npm 是 JavaScript 包管理器,使用 npm 包可以加快构建进程,提高代码质量,缩短开发时间。Metalsmith 是基于 Node.js 的静态网站生成器,可以生成静态网站、博客、电子书等。

Metalsmith-push 是一个可以自动化部署网站到远程 GitHub Pages 的插件。本文将重点介绍如何使用 metalsmith-push 插件来自动部署静态网站到 GitHub Pages 中。

安装

使用 npm 安装 metalsmith-push 依赖:

配置

首先需要在 metalsmith 根目录下创建一个配置文件,一般命名为 metalsmith.json。然后参考如下形式进行配置:

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

其中部署相关的选项为:

  • remote: 你的 GitHub Pages 仓库地址
  • src: 被构建项目的输出目录
  • force: 是否强制推送,如果为 false,则当目标分支存在时,不会进行覆盖操作
  • message: 提交信息
  • branch: 部署目标分支,默认为 gh-pages
  • clone: 克隆仓库的地址,如果部署目标分支不存在,会自动创建一个新的分支
  • ignore: 忽略的文件或目录
  • remoteBranch: 远程分支,默认为 gh-pages
  • pushFirst: 是否先推送源分支

使用

在配置好 metalsmith-push 后,可以使用以下指令进行部署操作:

在执行此命令后,静态网站将被自动构建并自动部署到 GitHub Pages 中。

示例代码

为方便起见,我们还提供了一个示例:

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

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

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

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

总结

通过本文,你已经了解了 metalsmith-push 的基本用法及相关配置。使用这个插件可以自动化部署你的静态网站到 GitHub Pages 中,非常的方便实用。对于前端开发人员来说,这是一篇非常有深度和学习及指导意义的文章,建议收藏备用。

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

纠错
反馈