在前端开发中,经常需要对网站进行搭建、部署、更改等操作,这时候一个静态站点生成器就尤其必要了。而 greater-site-builder 就是一个非常实用的 npm 包,可以帮助我们快速生成静态网站,提高开发效率。本文将为大家介绍 greater-site-builder 的使用和相关技巧。
什么是 greater-site-builder?
greater-site-builder 是一个基于 Node.js 的静态站点生成器,可以让我们快速生成静态网站,支持使用 markdown、ejs 等模板语言,同时也支持使用 Sass 等 CSS 预处理器。通过使用 greater-site-builder,我们可以快速构建一个简单、方便的静态网站。
安装
安装 greater-site-builder 很简单,只需要在终端中输入以下命令即可:
npm install greater-site-builder
安装完成后,我们就可以开始使用了。
使用
使用 greater-site-builder 可以分为以下几步:
1. 初始化项目
在项目根目录下执行以下命令进行初始化:
greater-site-builder init
执行命令后,会自动生成以下文件:
├── _config.yml // 配置文件 ├── _src // 源码目录 │ ├── scss // 存放样式文件的目录 │ ├── templates // 存放模板文件的目录 │ └── pages // 存放 markdown 文件目录 ├── _site // 生成的站点目录 └── node_modules // 依赖包目录
其中 _src
目录中的 scss
目录存放样式文件,templates
目录存放模板文件,pages
目录存放 markdown 文件。
2. 编辑配置文件
在 _config.yml
中设置一些基本的配置项,例如站点标题、模板文件路径、CSS 文件路径等,具体配置项可以参考文档。
3. 编写模板文件
在 templates
目录下编写模板文件,可以使用 ejs 模板引擎,支持包含变量、循环、判断等语句,使页面具有更高灵活度。
例如,我们创建一个 index.ejs
模板文件,代码如下:
-- -------------------- ---- ------- --------- ----- ------ ------ ---------- ---------- ---------- ----- ---------------- --------- -------- --- -- ------- ------ -------- ------- ---------- ------- ----- ---- -- --- ---- ---- - - ----------------- ---- --- ------ --------- ---------------- ------- ----------------- ----------- ----- ----- ------ --------- ------ --- -------- -- ------- ------- -------
上述代码中,变量 site
表示我们在 _config.yml
文件中定义的站点信息,contents
表示 markdown 文件渲染后的 HTML 内容。
4. 编写 markdown 文件
在 pages
目录下编写 markdown 文件,可以使用 markdown 语法,例如:
-- -------------------- ---- ------- - --- ------- -- ---- ------- ------------- -------- ----- - ------------------ -------- -
子标题二
这是一张图片:
-- -------------------- ---- ------- --- -- ------ - ------ -------------- ---- --- --------- ------------ -------- ------- ----------------- -------- -------------- ----- ---- - ----------------- ----------------- ------ -------------- ------------ ---------- ------ ---------- ------ ----------- - ------ - ----------------- -------------- ------ ----- ------- ----- -------- ----- ---------------- -------------- ------------ ------- -- - ------- -- -------- ---- ---------- ----- - --- - -- - ----------- ----- ------- -- -------- -- -------- ----- ------------ ------- -- - ------------ ----- - - ------ ----- ---------------- ----- ------- - ---------------- ---------- - - - - - -
6. 生成站点
在项目根目录下执行以下命令生成站点:
greater-site-builder build
执行命令后,会在 _site
目录下生成静态网站,可以直接在浏览器中查看。
结语
通过本文的介绍,我们了解了 greater-site-builder 的基本使用方法,这个工具可以让我们更加方便快捷地进行静态网站的搭建和管理。希望本文对大家有所帮助,有关于 greater-site-builder 的更多使用技巧和实践,可以参考官方文档和其他学习资料。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f8c238a385564ab6e6b