npm 包 greater-site-builder 使用教程

在前端开发中,经常需要对网站进行搭建、部署、更改等操作,这时候一个静态站点生成器就尤其必要了。而 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 很简单,只需要在终端中输入以下命令即可:

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

安装完成后,我们就可以开始使用了。

使用

使用 greater-site-builder 可以分为以下几步:

1. 初始化项目

在项目根目录下执行以下命令进行初始化:

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

执行命令后,会自动生成以下文件:

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

其中 _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. 生成站点

在项目根目录下执行以下命令生成站点:

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

执行命令后,会在 _site 目录下生成静态网站,可以直接在浏览器中查看。

结语

通过本文的介绍,我们了解了 greater-site-builder 的基本使用方法,这个工具可以让我们更加方便快捷地进行静态网站的搭建和管理。希望本文对大家有所帮助,有关于 greater-site-builder 的更多使用技巧和实践,可以参考官方文档和其他学习资料。

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


猜你喜欢

  • npm 包 react-data-grid-wow 使用教程

    在前端开发中,表格是一个经常需要使用的组件。但是如果每次都需要手写表格的样式和交互逻辑,会相当繁琐。这时,我们可以使用一些表格组件库来简化我们的开发流程。其中,react-data-grid-wow ...

    3 年前
  • npm 包 sequentialize 使用教程

    在前端开发过程中,我们经常需要处理多个异步函数的调用顺序问题。这时候,一个名为 Sequentialize 的 npm 包就可以派上用场了。Sequentialize 可以按照指定的顺序执行异步函数,...

    3 年前
  • npm 包 @hokid/generator-sazy 使用教程

    前端开发人员经常需要使用许多 npm 包来构建和管理项目。本文将介绍一个名为 @hokid/generator-sazy 的 npm 包,它可以帮助我们简化项目的构建和维护过程。

    3 年前
  • npm 包 @hokid/generator-vuetut 使用教程

    在前端开发中,Vue.js 已经成为了非常受欢迎的框架之一,它可以帮助我们快速构建用户界面。而在编写 Vue.js 应用程序时,我们经常需要编写大量的测试代码来确保应用程序的正确性和稳定性。

    3 年前
  • npm 包 @harrison-ifeanyichukwu/xml-serializer 使用教程

    介绍 在前端开发中,我们常常需要将数据以 XML 格式进行传输。但是,将数据转换为 XML 格式并非是一件容易的事情。由于 XML 的规范较为复杂,需要遵循一定的语法规则,因此我们需要借助一些工具来帮...

    3 年前
  • npm 包 @koehlerb/feathers-datastore 使用教程

    在前端开发中,我们经常需要对数据进行增删改查的操作,而 @koehlerb/feathers-datastore 正是一个帮助我们完成这些操作的 npm 包。本文将介绍该包的使用教程。

    3 年前
  • npm 包 @matthewp/display-drawer 使用教程

    在前端开发中,我们经常需要在页面中展示大量的数据,对于用户来说,看到一块巨大的数据很容易让其感到困惑和不知所措。为了解决这个问题,我们可以使用抽屉式展示组件,将数据分层次展示,以提高用户的可读性和可视...

    3 年前
  • npm 包 sectionize 使用教程

    在前端开发中,我们常常需要对文章或者页面进行分段展示和样式调整。而在这个过程中,我们会发现一个名叫 sectionize 的 npm 包,它可以帮助我们快速地将页面内容分段。

    3 年前
  • npm 包 @dilan2/ckeditor5-build-imageupload 使用教程

    前言 在前端开发中,富文本编辑器是一个常见的需求。其中,CKEditor 是一个流行的开源富文本编辑器。为了扩展 CKEditor 的功能,社区开发了许多插件,而这些插件通常以 npm 包的形式发布。

    3 年前
  • npm包gendiff-emk使用教程

    随着前端开发变得越来越复杂,代码的维护过程变得越来越困难。为了避免出现问题,我们需要对代码进行更加严格的测试和检查。 其中之一就是比较两个文件之间的差异,并且将其以一种易于阅读的方式展示出来。

    3 年前
  • npm 包 api-console-dev-preview 使用教程

    在前端开发中,调试 API 是非常常见的任务。一个好的 API 调试工具可以提高我们的开发效率。而 npm 包 api-console-dev-preview 就是一款非常好的 API 调试工具。

    3 年前
  • npm 包 images-drop-area-component 的使用教程

    前言 在前端开发过程中,图片上传是一个常见需求,在以往的实现方式中,最常用的是利用 input 标签进行文件选择,再通过 ajax 或 form 表单提交实现上传。

    3 年前
  • npm 包 node-red-contrib-gitlab 使用教程

    当今时代,GitLab 已成为一个非常流行的代码托管平台,而且在使用中发现,部署与配置都比较方便。为了方便开发人员更好的使用 GitLab,npm 上已有了一个名为 node-red-contrib-...

    3 年前
  • npm 包 react-native-scrollable-tab-view-cys 使用教程

    前言 在前端开发中,移动端开发的需求越来越普遍,同时也为我们带来了新的技术挑战。在移动端开发中,很多时候我们需要用到 tab 栏,为了方便我们的开发,这里介绍了一个 npm 包:react-nativ...

    3 年前
  • npm 包 grunt-jfw 使用教程

    在前端开发中,我们经常需要使用一些自动化构建工具来优化我们的开发效率,其中像 Grunt、Gulp 等构建工具就是非常常用的工具之一。今天我们将介绍 Grunt 中的一个常用插件——grunt-jfw...

    3 年前
  • npm 包 simple-javascript-router 使用教程

    在前端开发中,常常需要通过 URL 控制页面的显示和跳转,这就需要使用到路由。而 simple-javascript-router 就是一个简单而强大的 JavaScript 路由库,能够通过监听 U...

    3 年前
  • npm 包 @mebank/fcm-push 使用教程

    Firebase Cloud Messaging (FCM) 是一款跨平台、开放式的消息传递服务,可供开发人员使用其 API 以将消息传送至云端网络。而使用 FCM,需要配置和设置各种设备和应用程序参...

    3 年前
  • npm 包 sanitize-mail 使用教程

    概述 在前端开发中,经常需要对用户输入的邮件地址进行验证和处理。而邮件地址中往往包含许多特殊字符,如 angle brackets(< >)、反斜杠(\)等。

    3 年前
  • npm 包 gekkio 使用教程

    为什么要学习 gekkio 当我们进行前端开发时,难免会遇到很多需要图形进行展示和交互的场景,而 gekkio 就是一款帮助开发者实现图形渲染和交互的 npm 包。

    3 年前
  • npm 包 react-network-info 使用教程

    在前端开发中,网络信息的获取是非常重要的一个环节,特别是在移动端浏览器中,网络情况时刻在变化,因此我们需要一个快速、准确地获取当前网络状态的工具。 在众多可供选择的 npm 包中,react-netw...

    3 年前

相关推荐

    暂无文章