git平台docsify布署markdown文件
git平台docsify布署markdown文件
本地安装
docsify 可以快速帮你生成文档网站。不同于GitBook、Hexo的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时。// 首先安装node
https://gitlab.com/xuyq123/mynotes/-/blob/master/%E5%85%B6%E4%BB%96/nodejs%20&%20vue.md// 安装docsify
npm i docsify-cli -gdocsify --version// 初始化docsify项目
docsify init ./test// 运行
docsify serve docshttp://localhost:3000
教程
https://docsify.js.org/#/zh-cn/quickstart
https://www.jianshu.com/p/4883e95aa903
https://marked.js.org/demo/修改主题
index.html
给每个页面的末尾加上 footer
window.$docsify = {
plugins: [
function(hook) {
var footer = [
'',
''
].join('');
hook.afterEach(function(html) {
return html + footer;
});
}
]
};
gitlab布署docsify
1、创建 .gitlab-ci.yml
2、创建docs目录,将markdown文件放在此处。推送文件。
3、推送文件。可参考此项目
https://gitlab.com/xuyq123/plain-docsify
https://xuyq123.gitlab.io/plain-docsify 多级页面可参考
https://gitlab.com/xuyq123/myblog-docsify
https://xuyq123.gitlab.io/myblog-docsify
.gitlab-ci.yml
image: ruby:alpinestages:
- deploypages:
stage: deploy
script:
- cp -r docs/. public
- echo "deploying to pages for note"
environment:
name: note
url: https://xuyq123.gitlab.io/plain-docsify
artifacts:
paths:
- public
only:
- master
github布署docsify
1、本地生成 docsify项目// 初始化docsify项目
docsify init ./test// 运行
docsify serve docs2、推送文件。3、开启github pages
位置:Setting - GitHub Pages - Save
选择对应目录。后期更新文件,只需推送即可。可参考此项目
https://github.com/scott180/myblog-docsify/
https://scott180.github.io/myblog-docsify/
gitee布署docsify
在对应的 Gitee 仓库服务中选择 Gitee Pages,选择您要部署的分支,填写您要部署的分支上的目录,
例如docs,填写完成之后点击启动即可。
示例
名称 | 仓库 | 备注 |
---|---|---|
plain-docsify | gitlab plain-docsify? 网页 github plain-docsify? 网页 |
笔记docsify |
myblog-docsify | gitlab myblog-docsify? 网页 github myblog-docsify? 网页 |
笔记与博客docsify |
推荐阅读
- github|Impact Tech, She Can | 报名倒计时,隐藏福利、参与好礼终极揭秘
- 开源云|开源云 IDE 产品新宠儿,如何使用 Gitpod 开发 APISIX()
- 艺术品NFT交易平台搭建|NFT商城开发
- TiDB数据库管控平台——TiEM初体验
- 国产化之x64平台安装银河麒麟操作系统
- 居然可以像玩游戏一样学Git
- 基于Kubernetes/K8S构建Jenkins持续集成平台(上)-2
- 版本管理工具|Git使用(Git安装、建立Git仓库、克隆Git仓库、提交代码至Git仓库)
- mac|MAC版本Typora+PiGo+GitHub免费图床搭建整理
- 搭建多个远程仓库,将代码同时提交Github、Gitee