npm 包 hekyll-cli 使用教程

阅读时长 3 分钟读完

简介

hekyll-cli 是一个基于 Node.js 的静态网站生成器,它能够通过 Markdown 文件快速生成静态网站。相比于其他网站生成器,hekyll-cli 更加轻量级和灵活,不需要数据库和服务器,生成的网站可以直接发布到 Github Pages 、Netlify 等静态网站托管平台中。

安装

在使用 hekyll-cli 之前,需要先安装 Node.js 和 npm。打开终端(Windows 用户打开 cmd 或 PowerShell),输入以下命令安装 hekyll-cli:

验证安装

安装完成后,可以通过以下命令验证是否安装成功:

如果能够显示出版本号,则说明安装成功。

创建网站

在终端中输入以下命令创建一个新的网站:

其中,myblog 是你的网站名称。执行命令后,会在当前目录下创建一个名为 myblog 的文件夹,该文件夹中包含了一个简单的网站模板。

配置

在创建网站后,需要对网站进行配置。打开 myblog 文件夹,编辑 _config.yml 文件,根据自己的需求进行配置。

以下是常见的配置选项:

  • title:网站标题
  • description:网站描述
  • url:网站地址
  • author:网站作者
  • permalink:文章链接的格式,默认为 /year/month/day/title.html
  • markdown:Markdown 渲染器的配置选项
  • theme:网站主题的名称

编写文章

在 myblog 文件夹中,进入 _posts 文件夹,创建一个名为 2021-01-01-my-first-post.md 的 Markdown 文件,填写以下内容:

其中,layout 表示文章的布局,title 表示文章的标题,date 表示文章的发布日期,categories 表示文章的分类。

生成网站

在编辑好文章后,可以执行以下命令生成网站:

该命令会在 myblog 文件夹中生成一个名为 _site 的文件夹,其中包含了生成的静态网站。可以通过浏览器打开其中的 index.html 文件,查看生成的网站效果。

发布网站

生成静态网站后,可以将其发布到任何一个静态网站托管平台中,例如 Github Pages、Netlify、Firebase Hosting 等。在发布之前,需要将 _site 文件夹中的内容上传到托管平台中,具体操作可以参考对应平台的文档。

结语

hekyll-cli 是一个快速生成静态网站的工具,它可以帮助前端工程师快速地搭建自己的博客网站。本文介绍了如何安装、创建、配置、编写文章、生成和发布静态网站,希望能够帮助读者更好地使用 hekyll-cli,让自己的思想和知识得到更广泛的传播。

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

纠错
反馈