简介
docpad-plugin-ghpages 是一款可以将 DocPad 生成的静态网站部署到 Github Pages 的插件，使用简单方便。
安装
首先，你需要有 Node.js 和 DocPad 环境，并已经初始化 DocPad 的项目。在项目目录下，使用以下命令安装 docpad-plugin-ghpages：
npm install --save docpad-plugin-ghpages
配置
在项目根目录下的 docpad.coffee（或者 docpad.js）中进行配置。添加以下内容：
plugins:
ghpages:
deployRemote: 'origin' // 远程仓库名
deployBranch: 'gh-pages' // 部署的分支
deployMessage: 'Site updated' // 部署提交信息
cleanUrls: true // 这不是必要的，但是可以使网址更加简洁使用
使用 DocPad 生成静态网站后，使用以下命令进行部署：
docpad deploy-ghpages --env static
其中，--env static 指定生成的静态网站路径。如果你的生成路径不是默认的 out/，需要在命令后添加静态网站路径，例如：
docpad deploy-ghpages --env ./path/to/generated/site/
如果部署成功，你会看到以下信息：
-- -------------------- ---- ------- ---------- ------ -- -------- ------ ------- ---------- --------- ------ ---------- -------- -------- ------ ---------- -------- -- - --- ------ ---------- ------- ----- ---------- ------- -- ------ ---- -
在 Github 上访问 http://<your-github-username>.github.io/<your-project-name>/，就可以看到你的网站啦！
示例
在配置好 docpad-plugin-ghpages 后，我们可以在 docpad.coffee 中添加以下内容：
-- -------------------- ---- -------
--------- ------ --
------ ---------------------- ------- - ---- ---- -------
------
------ ------ -------------------- - -----------------
------ ------ --------------------------- - ---------------
- ---- ---- ----------
-------------- - --------------- -- -- ----------------------------------------------------------------------------- - --------------
- --------------
-------------------- -- ------------- ------ ----------------------------- ------------
-------------------------- - ---------------------------
- ----------
----------- ----------- ----------------------- -- -------------------------------这段代码的作用是，在生成 HTML 文件时，如果当前文件的路径存在 @document.attributes.deploy 属性，就会在 HTML 文件中添加一个跳转链接，并设置头信息使浏览器直接跳转到指定链接。最后会在命令行输出相关信息。
我们可以通过为每个页面添加 deploy 属性，指定该页面需要跳转的链接。例如，在某个页面的头信息中添加 deploy: 'http://example.com'，就可以使该页面跳转到 example.com 网站。
小结
docpad-plugin-ghpages 是一款方便的插件，可以将 DocPad 生成的静态网站部署到 Github Pages。通过简单的配置和使用，我们可以快速部署自己的网站。在此基础上，我们还可以添加一些代码，进行一些自定义的操作，进一步优化我们的网站。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/61854