快速开始

文章目录

1. 1. 准备工作
   1. 1.1. 安装git
   2. 1.2. 安装node.js
   3. 1.3. 安装hexo
   4. 1.4. 从仓库拉取项目
2. 2. 开始写作
3. 3. 上传
   1. 3.1. 本地提交
   2. 3.2. 远程推送
4. 4. 参考资料

本教程是帮助同好会成员简单、快速地将写作环境部署到本机上进行写作

准备工作

如果您遇到什么问题，请在群内交流

安装git

Windows：

• 直接在git官网进行安装

• 使用winget一键安装

  winget install --id Git.Git -e --source winget

Linux(Ubuntu, Debian):

• 使用apt

  sudo apt install git

安装node.js

Node.js 为大多数平台提供了官方的 安装程序。

安装hexo

所有必备的应用程序安装完成后，即可使用 npm 安装 Hexo。

npm install -g hexo-cli

对于熟悉 npm 的进阶用户，可以仅局部安装 hexo 包。

npm install hexo

从仓库拉取项目

1. 从同好会的github仓库拉取到本项目代码

   git clone <github仓库地址>

2. 安装依赖

   进入项目根目录（跟package.json同级！！）

   cd club-blog

   安装项目依赖

   npm install

   等待执行完毕，如果没有报错，就大功告成辣~~

   遇到问题群里问我

开始写作

你可以执行下列命令来创建一篇新文章或者新的页面。

npm run new -- "一级分类/二级分类/文章标题"

这里的“–”是必须的

例如

npm run new -- "技术/前端/JavaScript高级技巧"

​ 这样在source/_posts/下创建一个嵌套目录

​ 打开后如下图显示

​

让我们来逐一解释

1. title: 测试 ：文章标题

2. toc: true：启用文章目录，具体效果是：

   1. 在文章页面侧边会自动生成一个文章目录
   2. 该目录基于文章中的标题（#、##、### 等）自动生成
   3. 目录项通常可以点击，快速跳转到文章相应章节

3. date：日期

4. tags：标签

5. categories ：分类

categories 可以不写，插件会根据路径自动生成

6. 参考资料：没有可以删掉

   如果有图片，直接将图片放在与文章标题同名的文件夹中，在markdown中引用时：

   ![image](测试md.png)

   或使用相对路径（推荐，更明确）：

   ![image](./测试md.png)

写作完成后可以使用以下命令来测试

npm run test

上传

测试完成后我们可以将更改推送到github上面，GitHub Actions将会自动将文章部署到服务器上

本地提交

使用git将文章提交到本地仓库

//暂存更改
git add .
//本地提交
git commit -m "简单描述一下干了什么"

远程推送

将更改提交本地仓库后，还需将仓库推送到远程仓库

git push

下次写文章前先从远程仓库拉取，获取最新仓库再进行写作

git pull

参考资料

• Hexo官方文档