文档
Source
Edit
History

wiki使用和部署指南

Catalogue
  1. 1. 下载
    1. 1.1. 方法一
    2. 1.2. 方法二
    3. 1.3. git终端
    4. 1.4. Gitkraken
  2. 2. 安装
    1. 2.1. 安装所需依赖
  3. 3. 测试部署
  4. 4. 编写
  5. 5. 参考资料

前置依赖项

　- shell 命令行
　- 基本Linux操作指令
　- git 基本语法
　- 能够登录github的网络

下载

方法一

git 克隆远程仓库到本地

1
git clone https://github.com/KVM-Explorer/KVM-Explorer.github.io

如果需要更改为自定义的文件夹名,支持嵌套命名如Blog/wiki/XXX

1
git clone https://github.com/KVM-Explorer/KVM-Explorer.github.io　<your directory name>

方法二

登录https://github.com/KVM-Explorer/KVM-Explorer.github.io手动下载仓库，Code -> Download ZIP,记得打星＾_＾

image-20211003084015737

git终端

用命令行终端进入仓库所在文件夹，此时显示当前仓库所在的分支为source 分支

image-20211003084319364

如果当前分支不是source分支，采用git checkout切换至source分支

Gitkraken

出于可视化和方便的需要我更为推荐采用deb安装的gitkraken进行git仓库的管理，流程如上

image-20211003084835430

安装

如果单纯上传下载文档可直接跳过此步骤

安装所需依赖

Nodejs14

1
2
3
# Using Ubuntu
curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

cnpm

由于Nodejs 自带的软件管理器为npm在国内不稳定推荐下载cnpm淘宝镜像或对npm进行换源

1
npm install cnpm

通过命令行进入仓库所在文件夹,安装wiki所需依赖

1
cnpm install

测试部署

生成网页版并在本机查看

1
2
hexo g # 生成网站
hexo s # 本地测试

image-20211003090750820

image-20211003090847009

编写

生成新文档

  1. 在所需要编写文档的文件夹建立新文件，在文件的开头添加yaml说明 每个属性：后注意添加空格，整个yaml用英文输入法进行编写
1
2
3
4
5
---
title: <title>
toc: true
date: 2022-01-12 09:00:00
---

推荐采用typora 进行markdown内容编写，调整图片设置自动保存到对应的asset（目前已不推荐，新的方式在Markdown插入图片更新)

  1. 进入source -> _post 将对应文件夹和文件移至所需分类目录，生成时即可按照文件层次分类

推荐采用typora 进行markdown内容编写，调整图片设置自动保存到对应的同名文件夹(已不推荐,推荐采用图床详情见Markdown插入图片)

文件->偏好设置->图像->插入图片时->复制到制定文件夹，同时勾选应用对象选项

image-20220111144932549

  1. Gitkraken 进行上传

    首先打开gitkraken进入当前项目，先拉取，commit后再push提交。

参考资料