docsify部署到GitHub Pages

2,684 阅读2分钟

Welcome to Linux DOC 👋

linuxDoc

Version GitHub juejin blog

git安装

下载git

sudo yum install git

如果使用Ubuntu系统,运行sudo apt-get install git

配置git

git config --global user.name "Your Name" 
git config --global user.email "email@example.com"

查看git配置是否生效

git config --list

配置远程仓库

ssh-keygen -t rsa -C "your_email@youremail.com"

一路回车即可,在root目录下.ssh文件夹内会生成id_rsaid_rsa.pub

在GitHub中配置SSH keys,并创建仓库

配置SSH keys

首先我们进入GitHub官网,点击右上角头像,选择Settings,然后选择SSH and GPG keys,在右边新建一个SSH keys。把上一步生成的id_rsa.pub填写到key下方,Title可以随意填写。

创建仓库

我们点击头像左边的+号,点击New repository创建一个新的仓库。

输入仓库名,其他保持默认即可。

初始化仓库

在本地新建一个文件夹mydoc

mkdir mydoc

初始化git

git init

初始化完成,我们来测试一下。

vim readme.txt

readme.txt里写一句话,然后输入:wq退出。

git add .
git commit -m "新建readme.txt"
git push origin master

然后刷新刚才创建的仓库,发现已经成功提交了。

安装npm

下载npm

wget https://nodejs.org/dist/v10.15.3/node-v10.15.3-linux-x64.tar.xz

解压

xz -d node-v10.15.3-linux-x64.tar.xz
tar -xvf node-v10.15.3-linux-x64.tar

把解压的文档移动到别的目录

mv node-v10.15.3-linux-x64 /usr/local/lib 
mv /usr/local/lib/node-v10.15.3-linux-x64/ /usr/local/lib/nodejs

添加环境变量

export PATH=/usr/local/lib/nodejs/bin:$PATH

创建链接

ln -s /usr/local/lib/nodejs/bin/node /usr/bin/node 
ln -s /usr/local/lib/nodejs/bin/npm /usr/bin/npm 
ln -s /usr/local/lib/nodejs/bin/npx /usr/bin/npx

可以使用node -vnpm version来查看版本信息。

使用docsify

安装

npm i docsify-cli -g

初始化

进入mydoc文件夹

docsify init ./docs

本地预览网站

docsify serve docs

通过docsify serve能运行一个本地服务器,方便预览。默认访问路径:http://localhost:3000 如果大家使用云服务器,那么默认访问路径为:http://<你的服务器ip>:3000/ 记得要放行3000端口。

如果下载缓慢的话,可以安装国内镜像来提升速度

国内npm镜像

npm config set registry https://registry.npm.taobao.org

GitHub Pages

点开仓库,选择Settings,往下拉找到GitHub Pages,按下图所示选择。

page

此时,点击上方分配的免费域名就看到页面了。

配置自定义域名

Custom domain选项中,填写自己的二级域名地址,点击save。使用自定义域名前,需要在域名商进行CNAME解析。记录值填写 yourname.github.io,其中yourname替换为你的github用户名。然后返回github官网等待域名证书,证书下发成功后,勾选GitHub Pages下的Enforce HTTPS按钮,刷新页面就可以了。