写点什么

白嫖 GitHub Pages,轻松搭建个人博客

作者:LigaAI
  • 2022-12-02
    广东
  • 本文字数:4015 字

    阅读完需:约 13 分钟

白嫖GitHub Pages,轻松搭建个人博客

Hexo 是一个快速、简单且功能强大的博客框架。使用 Markdown 解析文档,Hexo 能在几秒内生成带有自定义主题并集成各项功能的网站页面。


本文采用 Github Pages + Hexo 的方式,搭建个人博客。


零、准备工作


1. 使用个人 GitHub 创建仓库,并配置 GitHub Pages


注意: 此仓库用于存放个人博客页面,仓库名必须使用 <GitHub用户名>.github.io 格式。


仓库创建完成后,可以在仓库根路径下创建一个名为 index.html 的静态 HTML 文件来验证个人博客搭建是否成功。


<!DOCTYPE html><html lang="en"><head>    <meta charset="UTF-8">    <title>Someone's Blog</title></head><body>    <h1>Hello, Blog World ~</h1></body></html>
复制代码


<GitHub用户名>.github.io 仓库对应的 GitHub Pages 设置页面 (访问路径为Settings -> Pages) 可以找到个人博客的主页访问地址:https://<GitHub 用户名>.github.io。


若能在浏览器中正常访问该地址,即代表个人 GitHub Pages 搭建成功。


2. 安装 Git 和 NodeJS


Hexo 基于 NodeJS 运行,因此在开始前,需要安装NodeJSnpm 工具。安装教程可参考如下步骤。


笔者的本地环境为 Windows 11 + PowerShell,包管理工具使用 Scoop,NodeJS 通过 nvm 管理,下述安装步骤需要在 PowerShell 里执行。


scoop install git # 安装Git
scoop install nvm # 安装 nvmnvm list available # 查看可用的 NodeJS 版本,这里建议使用 LTS 版本nvm install 16.18.0 # 安装 NodeJS,我这里安装的是最新 LTS 版本 16.18.0sudo nvm use 16.18.0 # NodeJS 版本使用 16.18.0,注意这里需要管理员权限,可以先使用 scoop 安装 sudo 这个工具
复制代码

一、安装 Hexo


此处只列出本次所需的关键步骤,更多说明详见官方文档:https://hexo.io/zh-cn/


1. 全局安装 hexo-cli 工具


npm install -g hexo-cli
hexo -v # 查看版本,目前最新版本为 4.3.0
复制代码


2. 创建一个项目 my-blog 并初始化


hexo init my-blogcd my-blognpm install
复制代码


3. 生成网页文件 &本地启动


hexo generate # 生成页面,此命令可以简写为 `hexo g`hexo server # 本地启动,可简写为 `hexo s`
复制代码


通过 hexo g 生成的页面文件在项目 public 目录下;


使用 hexo clean 命令可以清理生成的页面文件。当配置未生效时,建议执行清理命令。


4. 本地访问


浏览器访问:http://localhost:4000/ 会看到一个比较简陋的页面。没关系,接下来介绍如何更换主题。

二、安装 &配置主题


按照前两个小节所介绍的步骤,我们已经能够通过本地访问博客页面了,但 Hexo 默认的主题不太好看。


好在官方提供了数百种主题任君选择,可以根据个人喜好更换,具体可以点击(https://hexo.io/themes/)查看。


本文将主要介绍 Fluid 主题的安装与配置。


1. 安装 Fluid 主题


官方提供了两种安装方式,这里使用官方推荐的 npm 方式。


npm install --save hexo-theme-fluid
复制代码


在博客根路径下创建 _config.fluid.yml 文件,并将主题的 ./node_modules/hexo-theme-fluid/_config.yml 文件内容复制过去。


2. 指定主题


将如下修改应用到 Hexo 博客目录中的 _config.yml:


theme: fluid  # 指定主题
language: zh-CN  # 指定语言,会影响主题显示的语言,按需修改
复制代码


3. 创建「关于页」


首次使用主题的「关于页」需要手动创建。


hexo new page about
复制代码


创建成功后修改 /source/about/index.md,添加 layout 属性。修改后的文件示例如下:


---title: 标题layout: about---这里写关于页的正文,支持 Markdown, HTML
复制代码


需要注意的是, layout: about 必须存在,并且不能修改成其他值,否则不会显示头像等样式。


4. 更新 Fluid 主题


通过 npm 安装主题的情况,可在博客目录下执行命令:


npm update --save hexo-theme-fluid
复制代码


5. 本地启动


执行如下命令重新生成页面,并启动 Hexo 服务。


hexo cleanhexo ghexo s
复制代码


再次通过浏览器访问 http://localhost:4000 , 便可以看到页面变得美观多了。

三、创建文章


修改 _config.yml 文件。这项配置是为了在生成文章的同时,生成一个同名的资源目录用于存放图片等资源文件。


post_asset_folder: true
复制代码


创建文件名为 my-blog-build-remark 文章。


hexo new post my-blog-build-remark
复制代码


设置文章的标题及其他元数据信息。


---title: 基于 GitHub Pages + Hexo 搭建个人博客date: 2022-10-16 19:42:53tags: ['hexo','fluid']---
复制代码


如上命令执行成功后,在 source/_posts/ 目录下生成了一个 Markdown 文件和一个同名的资源目录。


source/_posts/my-blog-build-remark 目录中放置一个图片文件 posts-file-tree.png,整体目录结构如下:


$ source/_posts (main)> tree.├── hello-world.md├── my-blog-build-remark│   └── posts-file-tree.png└── my-blog-build-remark.md
复制代码


然后在文章的 Markdown 文件里,通过以下方式即可引用对应的图片。


{% asset_img posts-file-tree.png 目录结构 %}
复制代码


图片的引用方式也不只一种,更多详细介绍可参考官方文档 (https://hexo.io/zh-cn/docs/asset-folders.html)


文章创建并编辑好之后,就可以通过 hexo g && hexo s 命令启动服务,并在本地预览文章。

四、配置指南


如无特殊说明,如下配置文件一律默认为主题配置文件_config.fluid.yml


1. 页面 title 修改


修改 _config.yml 文件。

title: "请填写你自己的博客标题"subtitle: ''description: ''keywords:author: 请填写你自己的署名language: zh-CNtimezone: ''
复制代码


2. 博客标题


页面左上角的博客标题,默认使用站点配置_config.yml中的 title


此配置同时控制着网页在浏览器标签中的标题,如需单独区别设置,可在主题配置中进行设置。

navbar:  blog_title: "请填写你自己的博客标题"
复制代码


3. 首页 - Slogan(打字机)


首页大图中的标题文字,可在主题配置中设定是否开启。这里支持配置固定的 text 或者从远程 api 实时获取,优先级 api > text

index:  slogan:    enable: true
    text: "Please type your slogan here."    api:      enable: true      url: "https://v1.hitokoto.cn/"      method: "GET"      headers: {}      keys: ["hitokoto"]
复制代码

五、网页访问统计


目前 Fluid 支持多种统计网站,本文仅介绍 LeanCloud 的配置。


使用 LeanCloud 之前,需要先注册账户并新建应用(需实名认证),可自行前往官网完成。


在 【控制台 -> 应用 -> 设置 -> 应用凭证】页面中找到对应的 AppIDAppKeyREST API 服务器地址等信息填入主题配置中。


web_analytics:  # 网页访问统计  leancloud:    app_id: # AppID    app_key: # AppKey    # REST API 服务器地址,国际版不填    # Only the Chinese mainland users need to set    server_url: # REST API 服务器地址
    # 开启后不统计本地路径( localhost 与 127.0.0.1 )    # If true, ignore localhost & 127.0.0.1    ignore_local: true
复制代码


如无特殊需要,记得配置 ignore_local: true,这样 LeanCloud 在 localhost 域名下访问不会增加数据。


1. 展示 PV 与 UV 统计


页脚可以展示 PV 与 UV 统计数据,目前支持两种数据来源:LeanCloud不蒜子

footer:  statistics:    enable: true    source: "leancloud"    pv_format: "总访问量 {} 次"    uv_format: "总访客数 {} 人"
复制代码


2. 展示文章日期/字数/阅读时长/阅读数


post:  meta:    author: # 作者,优先根据 front-matter 里 author 字段,其次是 hexo 配置中 author 值      enable: false    date: # 文章日期,优先根据 front-matter 里 date 字段,其次是 md 文件日期      enable: true      format: "LL a" # 格式参照 ISO-8601 日期格式化 See: http://momentjs.cn/docs/#/parsing/string-format/    wordcount: # 字数统计      enable: true      format: "{} 字"    min2read: # 估计阅读全文需要的时长      enable: true      awl: 2      wpm: 60      format: "{} 分钟"    views: # 浏览量计数      enable: true      source: "leancloud"      format: "{} 次"
复制代码


3. 文章评论功能


评论功能需要在主题配置中开启并指定评论插件,这里使用基于 LeanCloudValine

post:  comments:    enable: true    # 指定的插件,需要同时设置对应插件的必要参数    # Options: utterances | disqus | gitalk | valine | waline | changyan | livere | remark42 | twikoo | cusdis | giscus    type: valine
# Valine# 基于 LeanCloud# See: https://valine.js.org/valine:  appId: # LeanCloud AppID  appKey: # LeanCloud AppKey
复制代码

六、发布 GitHub Pages


1. 安装 hexo-deployer-git


npm install hexo-deployer-git --save
复制代码


2. 修改站点配置 _config.yml


deploy:  type: git  repo: <repository url> # https://github.com/<GitHub用户名>/<GitHub用户名>.github.io.git  branch: [branch]  token: [token]
复制代码


3. 生成站点文件并推送至远程 GitHub 仓库。


hexo cleanhexo deploy
复制代码


登入 Github,在库设置(Repository Settings)中将默认分支设置为 _config.yml 配置中的分支名称。


只需稍等片刻,个人博客站点就会显示在 Github Pages 中。

七、参考资料


  • Hexo Docs:https://hexo.io/zh-cn/docs/

  • Hexo Fluid 用户手册:https://fluid-dev.github.io/hexo-fluid-docs/



了解更多敏捷开发、项目管理、行业动态等消息,可关注LigaAI获取更多咨讯。


LigaAI 期待与你一路同行,助力开发者扬帆远航!

发布于: 刚刚阅读数: 3
用户头像

LigaAI

关注

新一代智能研发协作平台 2021-02-23 加入

AI赋能工作场景,想要做最懂开发者的智能研发管理平台~

评论

发布
暂无评论
白嫖GitHub Pages,轻松搭建个人博客_Hexo_LigaAI_InfoQ写作社区