简介
godless 是一个用于构建静态网页的 npm 包，采用 Handlebars 模板和 Markdown 作为输入，并可输出 HTML 或 PDF 文件。使用 godless 可以方便地将文档转化成漂亮的网页或打印材料。
安装
在终端输入以下命令安装 godless：
--- - -- -------
这将全局安装 godless 命令行工具。
使用
初始化项目
首先，需要创建一个新的 godless 项目。在终端中进入到想要存放项目的目录，输入以下命令：
------- ---- ---------
这会自动创建一个名为 myproject 的项目，并将默认模板和样式复制到该项目。
添加文档
在项目目录中，将要处理的 Markdown 文件放在 src/markdown 文件夹下，godless 会自动将其解析为 HTML。
在 Markdown 文件中，可以使用 Handlebars 语法嵌入动态内容。例如：
------- ------- ------------- -------------- ---------
这里 items 是一个数组，会根据数组的元素数量循环输出 li 元素。
模板
可以自定义模板，用于渲染 HTML。在 src/templates 文件夹下创建 index.hbs 文件，godless 将使用此模板生成输出。
模板中可以嵌入 Markdown 文件中定义的 Handlebars 表达式。例如：
------------------ -------------
这里 title 和 content 都是在 Markdown 文件中定义的变量。
样式
可以自定义样式表，用于美化输出的 HTML。在 src/css 文件夹下创建 main.css 文件，godless 将使用此样式表渲染输出。
输出
在终端中进入项目目录，输入以下命令：
------- -----
这将生成包含所有 Markdown 文件处理结果的 HTML 文件，并且将 src/images 文件夹下的图片复制到输出文件夹中。
如果想要生成 PDF 文件，需要将 pandoc （一个文档格式转换工具）安装到本地。在终端中输入以下命令：
---- ------- ------
这将在 macOS 系统下安装 pandoc。然后，在终端中输入以下命令：
------- ---------
这将生成包含所有 Markdown 文件处理结果的 PDF 文件。
示例代码
以下是一个简单的示例：
- 在终端中创建一个新项目：
------- ---- ---------
- 在
src/markdown文件夹下创建index.md文件：
- ------ ------ ---- -- - ------ --------
- 在
src/templates文件夹下创建index.hbs文件：
--------- ----- ------ ------ ----- ---------------- ------------------------ ----- ---------------- ----------------------- ------- ------ ------------------ ------------- ------- -------
- 在
src/css文件夹下创建main.css文件：
---- - ---------- ----- ------ ----- -
- 在终端中生成 HTML 文件：
------- -----
- 生成结果将会在
dist文件夹下。
结语
godless 可以帮助前端开发人员方便地将 Markdown 文件转化为漂亮的网页或打印材料。不仅如此，它还支持自定义模板和样式表，让用户更多地掌控生成结果。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055eb081e8991b448dc47a