开发工具总结(13)之Hexo制作文档并发布到GitHub

时间:2022-06-25
本文章向大家介绍开发工具总结(13)之Hexo制作文档并发布到GitHub,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

本文出自 AWeiLoveAndroid的博客

Hexo是一个很不错的文档工具,有着大量丰富的模板,很多开发者都在使用Hexo模板创建个人博客。如果你看到一个不错的模板,可以直接下载下来,然后修改一下配置,写自己的MD文件,一键生成html文件,可以直接部署到github。是不是很爽?省时省力。下面讲解一下Hexo之多文档详细的过程。

一、安装必备工具

(1)安装git(大家基本都会)

具体操作请查看我的博客:开发工具总结(3)之Git及GitHub快速入门图文全面详解https://www.jianshu.com/p/3f12bd3ccf2a

(2)安装Node.js

具体操作请查看我的博客:开发工具总结(11)之nodejs、npm和yarn安装和使用和填坑详解 https://www.jianshu.com/p/9eba0e2c0697

(3)执行npm install -g hexo-cli下载hexo工具。


二、通用配置步骤(不管是什么hexo模板基本都有这几个步骤)

1.下载主题代码

hexo init blogname 创建一个名为blogname的文件夹 cd blogname 打开blogname文件夹 git clone https://github.com/xxx/yyy.git themes/aaa 从github下载源码,我这里选择的是https://github.com/xxx/yyy这个库。这个命令意思是把github下载到指定文件夹里面的themes/aaa这个文件目录。我们可以看到blogname/themes/目录里面多了一个aaa文件夹。

2.修改hexo配置文件

修改hexo的配置文件:blogname/_config.yml

例如:

# ... 
title: 您自己的网站标题
subtitle: # 不需要填写
description: 您自己的网站描述
keywords: 您自己的网站关键词
author: 您的姓名
language: zh-Hans # 目前仅支持中文
timezone: # 不需要填写

permalink: passages/:title/  # 如果您需要开启评论和文章统计,请修改此配置

# 设置主题
theme: aaa # 启用 "aaa" 主题

# ...

当然这个配置有很多,根据不同的hexo主题的要求进行个性化设置即可。

3.修改主题配置文件:

主题配置文件:blogname/themes/bmw/_config.yml

4.启动博客

执行命令 hexo s 启动博客,然后使用Chrome等主流浏览器打开 http://localhost:4000/ ,查看博客。

5.生成html源码

如果想部署到外部服务器,可以使用命令hexo g生成html源码。


三、遇到的坑

1、项目里面的node_module文件夹删除之后报错Local hexo not found in xxx

【解决方案】命令行进入项目路径,执行命令npm install


四、美化Hexo文档(可选)


注:本文参考hexo文档地址:https://hexo.io/zh-cn/docs/ 有不懂的可以去查看。