今天配置了一个 Vuepress 来当平时的笔记。
# 安装
新建一个项目，然后 # 安装为本地依赖项
yarn add -D vuepress # 或 npm install -D vuepress
#创建一个 docs 目录
mkdir docs
# 创建一个 markdown 文件
echo '# Hello VuePress' > docs/README.md
然后新建一个 package.json，给 package.json 添加一些 scripts 脚本:
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
你现在就可以开始编写文档了：
yarn docs:dev # 或 npm run docs:dev
要生成静态资源，请运行：
yarn docs:build # 或 npm run docs:build
# 部署在 GitHub 上
在项目的根目录上新建一个 deploy.sh 的脚本
#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
npm run docs:build
# 进入生成的文件夹
cd docs/.vuepress/dist
git init # 新建空仓库
git add . # 将所有文件add
git commit -m "first commit"
# 注意注意 一定要先在GitHub新建一个<USERNAME>.github.io的仓库
# 如果发布到 https://github.com/<USERNAME>/<USERNAME>.github.io.git
git push -f https://github.com/huzidabanzhang/huzidabanzhang.github.io.git master
# 如果发布到 https://<USERNAME>.github.io/<REPO>
# git push -f git@github.com:huzidabanzhang/blog.git master:gh-pages
cd -
上面的 USERNAME 是你自己的 github
这边刚开始遇到一个坑就是 git push 的时候 文档写的是 SSH 但是后面发现 push 不上去
后面我换成 https 来提交就可以 查资料发现是 SSH 的密钥问题
git remote rm origin
# 进入你的.ssh文件夹
eval $(ssh-agent)
# 然后
ssh-add id_rsa
# 然后
ssh-add -l
# 如果你输出了一串rsa秘钥，那么问题就解决啦
这是一个解决方案 不过我还没有试过 明天试一下看看 是不是真的有效
这个脚本写完后 基本就是一些 Vuepress 的配置问题 可以参考 Vuepress
你写完要发布的就是点击运行 deploy.sh 文件就可以了 你可以输入 <USERNAME>.github.io 来看下