前言
base-admin从开源至今，已经收获了2k Stat，而我们一直都没有一份像样的在线文档，最近写了一个博客园随笔备份Java脚本，将博客随笔备份到本地，格式是md文档格式，就有意去找将md文档转成html的工具，最后选用了下面这个文档网站生成器，经过一段时间的学习、编写文档，配合Gitee Pages服务，重要有了一个像样的项目网站
https://huanzi-qch.gitee.io/base-admin
文档网站生成器
docsify 一个神奇的文档网站生成器，官网：https://docsify.js.org
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。
特性
- 无需构建，写完文档直接发布
- 容易使用并且轻量 (压缩后 ~21kB)
- 智能的全文搜索
- 提供多套主题
- 丰富的 API
- 支持 Emoji
- 兼容 IE11
- 支持服务端渲染 SSR
可以选择使用脚手架来快速初始化文件
npm i docsify-cli -g也可以手动创建文件，一个index.html入口页面，一个README.md文档，还有一个.nojekyll的文件
把这些文件丢到tomcat或者nginx中，把容器运行起来就可以访问！
docsify可以高度定制化，同时也有着丰富的插件列表
Gitee Pages服务
有人说你为什么不买个服务器、域名？搞开源嘛就是用爱发电，能白嫖就白嫖，不寒碜！
同时，为了节省仓库空间，文档中部分图片是直接引用博客园博客里面的图片地址，因此要做反防盗链处理
//img图片反防盗链，给所有img标签都加上referrerPolicy属性
for(let img of document.getElementsByTagName('img')){
img.setAttribute('referrerPolicy','no-referrer');
}在gitee上创建一个与用户名同名的私有仓库，创建一个文件夹存放docsify相关文件
部署gitee pages服务
这样我们的项目网站就部署成功了！
封装
为了方便其他地方也使用同一份配置，我封装了自己的mydocsify.js、mydocsify.css脚本页面访问统计
封装css
/* 侧边栏 */
.sidebar{
padding: 25px 0 0 !important;
}
/* 自定义右侧目录 */
.catalogue{
display: block;
overflow: hidden;
position: fixed;
right: 15px;
top: 100px;
padding: 15px 30px;
background: white;
color: rgb(102, 102, 102);
border: 1px solid rgb(221, 221, 221);
border-radius: 4px;
line-height: 42px;
font-size: 16px;
text-align: center;
box-shadow: rgb(238 238 238) 0px 0px 6px;
cursor: pointer;
}
.catalogue-h2{
display: block;
text-decoration: none;
color: #505d6b;
margin-left: 0px;
font-size: 14px;
line-height: 25px;
text-align: left;
}
.catalogue-h3{
display: block;
text-decoration: none;
color: #505d6b;
margin-left: 20px;
font-size: 14px;
line-height: 25px;
text-align: left;
}
/* 首页按钮 */
section.cover .cover-main > p:last-child a {
border-radius: 0.5rem !important;
}封装js
let body = document.body;
let head = document.head;
let logaPath = 'https://huanzi-qch.gitee.io/file-server/images/logo.png';
let nodeArray = [
//logo
{tagName:'link',rel:'shortcut icon',type:'image/x-icon',href:logaPath},
//docsify脚本
{tagName:'link',rel:'stylesheet',href:'https://cdn.jsdelivr.net/npm/docsify/themes/vue.css'},
{tagName:'script',src:'https://cdn.jsdelivr.net/npm/docsify/lib/docsify.js'},
//插件
{tagName:'script',src:'https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js'},
{tagName:'script',src:'https://busuanzi.ibruce.info/busuanzi?jsonpCallback=BusuanziCallback'},
];
//通用配置
window.$docsify = {
name: 'huanzi-qch',
loadNavbar: true,//导航栏
loadSidebar: true,//目录栏
coverpage: true,//封面
onlyCover: true,
auto2top: true,
busuanzi_value:{
site_uv: 0,
page_pv: 0,
site_pv: 0
},
plugins: [
//底部版权声明
function(hook, vm) {
hook.beforeEach(function(html) {
let newHtml = html +
"n" +
"<hr>" +
//"<a target='_blank' href=''></a><br/>" +
"<p>AD广告位（长期招租，如有需要请私信）</p>" +
"<a target='_blank' href='https://promotion.aliyun.com/ntms/act/ambassador/sharetouser.html?userCode=ckkryd9h&utm_source=ckkryd9h'>【阿里云】新老用户同享，上云优化聚集地！</a><br/>" +
"<a target='_blank' href='https://www.aliyun.com/activity?userCode=ckkryd9h'>【阿里云】最新活动页，上新必买抢先知，劲爆优惠不错过！</a><br/>" +
"<a target='_blank' href='https://www.aliyun.com/daily-act/ecs/activity_selection?userCode=ckkryd9h'>【阿里云】轻量应用服务器2核2G 低至60元/年起！香港与海外服务器最低24元/月起！</a><br/>" +
"<a target='_blank' href='https://www.aliyun.com/daily-act/ecs/care?userCode=ckkryd9h'>【阿里云】ECS实例升级、续费，享低至 6.3折 限时折扣！</a><br/>" +
"<a target='_blank' href='https://cloud.tencent.com/act/cps/redirect?redirect=1077&cps_key=e1c9db729edccd479fc902634492bf53&from=console'>【腾讯云】云产品限时秒杀，爆款1核2G云服务器，首年74元！</a><br/>" +
"<a target='_blank' href='https://cloud.tencent.com/act/cps/redirect?redirect=1068&cps_key=e1c9db729edccd479fc902634492bf53&from=console'>【腾讯云】境外1核2G服务器低至2折，半价续费券限量免费领取！</a><br/>" +
"<a target='_blank' href='https://cloud.tencent.com/act/cps/redirect?redirect=1063&cps_key=e1c9db729edccd479fc902634492bf53&from=console'>【腾讯云】星星海SA2云服务器，1核2G首年99元起，高性价比首选！</a><br/>" +
"<a target='_blank' href='https://cloud.tencent.com/act/cps/redirect?redirect=1060&cps_key=e1c9db729edccd479fc902634492bf53&from=console'>【腾讯云】中小企业福利专场，多款刚需产品，满足企业通用场景需求，云服务器2.5折起！</a><br/>" +
"<br/><br/>" +
"<span style='float: left;'>Copyright © 2021 - 至今 huanzi-qch</span>" +
"<span id='busuanzi_container_site_pv' style='float: right;'>本站总访问量 <span id='busuanzi_value_site_pv'>"+window.$docsify.busuanzi_value.site_pv+"</span> 次</span>";
return newHtml;
});
},
//返回顶部
function(hook, vm) {
var CONFIG = {
auto: true,
text: 'Top',
right: 15,
bottom: 140,
offset: 500
}
var opts = vm.config.scrollToTop || CONFIG;
CONFIG.auto = opts.auto && typeof opts.auto === "boolean" ? opts.auto : CONFIG.auto;
CONFIG.text = opts.text && typeof opts.text === "string" ? opts.text : CONFIG.text;
CONFIG.right = opts.right && typeof opts.right === "number" ? opts.right : CONFIG.right;
CONFIG.bottom = opts.bottom && typeof opts.bottom === "number" ? opts.bottom : CONFIG.bottom;
CONFIG.offset = opts.offset && typeof opts.offset === "number" ? opts.offset : CONFIG.offset;
var onScroll = function(e) {
if (!CONFIG.auto) {
return
}
var offset = window.document.documentElement.scrollTop;
var $scrollBtn = Docsify.dom.find("span.scroll-to-top");
$scrollBtn.style.display = offset >= CONFIG.offset ? "block" : "none"
};
hook.mounted(function() {
var scrollBtn = document.createElement("span");
scrollBtn.className = "scroll-to-top";
scrollBtn.style.display = CONFIG.auto ? "none" : "block";
scrollBtn.style.overflow = "hidden";
scrollBtn.style.position = "fixed";
scrollBtn.style.right = CONFIG.right + "px";
scrollBtn.style.bottom = CONFIG.bottom + "px";
scrollBtn.style.width = "50px";
scrollBtn.style.height = "50px";
scrollBtn.style.background = "white";
scrollBtn.style.color = "#666";
scrollBtn.style.border = "1px solid #ddd";
scrollBtn.style.borderRadius = "4px";
scrollBtn.style.lineHeight = "42px";
scrollBtn.style.fontSize = "16px";
scrollBtn.style.textAlign = "center";
scrollBtn.style.boxShadow = "0px 0px 6px #eee";
scrollBtn.style.cursor = "pointer";
var textNode = document.createTextNode(CONFIG.text);
scrollBtn.appendChild(textNode);
document.body.appendChild(scrollBtn);
window.addEventListener("scroll", onScroll);
scrollBtn.onclick = function(e) {
e.stopPropagation();
var step = window.scrollY / 15;
var scroll = function() {
window.scrollTo(0, window.scrollY - step);
if (window.scrollY > 0) {
setTimeout(scroll, 15)
}
};
scroll()
}
})
}
]
};
//更新自定义右侧目录，以及反防盗链
function update(url){
//自动目录
let catalogue = document.getElementsByClassName('catalogue');
if(catalogue.length <= 0){
catalogue = document.createElement('div');
catalogue.className = 'catalogue';
body.append(catalogue);
}else{
catalogue = catalogue[0];
catalogue.innerHTML = "";
}
catalogue.style.display='none';
setTimeout(function () {
//img图片反防盗链
for(let img of document.getElementsByTagName('img')){
img.setAttribute('referrerPolicy','no-referrer');
}
//自动目录
for(let child of document.getElementById('main').children){
if(child.nodeName === 'H2' || child.nodeName === 'H3'){
let a = document.createElement('a');
a.href = url + "?id=" + child.id;
a.innerText = child.innerText;
if(child.nodeName === 'H2'){
a.className = 'catalogue-h2';
}else{
a.className = 'catalogue-h3';
}
catalogue.append(a);
}
}
catalogue.style.display='block';
},1000);
}
//不蒜子 页面访问统计回调
function BusuanziCallback(data){
window.$docsify.busuanzi_value = data;
document.getElementById('busuanzi_value_site_pv').innerText = window.$docsify.busuanzi_value.site_pv;
}
//DOM加载完成执行
(function (){
//动态引入脚本
for(let node of nodeArray){
let element = document.createElement(node.tagName);
for(let key in node){
if('tagName' != key){
element[key] = node[key];
}
}
if('link' == node.tagName){
head.append(element);
}else{
body.append(element);
}
}
//离线模式
if (typeof navigator.serviceWorker !== 'undefined') {
navigator.serviceWorker.register('https://huanzi-qch.gitee.io/file-server/files/docsify-sw.js');
}
//监听URL发生变化，是否生成自定义右侧目录
let url = window.location.href;
if(url.indexOf('docs') !== -1){
url = window.location.hash.split("?")[0];
update(url);
}
window.onhashchange = function () {
let hash = window.location.hash.split("?")[0];
if(hash != '#/' && url.indexOf(hash) === -1){
url = hash;
update(url);
}else{
let catalogue = document.getElementsByClassName('catalogue');
if(window.location.href.indexOf("docs") === -1 && catalogue.length > 0){
catalogue[0].remove();
}
}
};
})();用的是快速统计插件不蒜子
封面的项目Star数，直接引用这两个图片链接即可（把项目地址 huanzi-qch/base-admin 换成自己的项目）
https://img.shields.io/github/stars/huanzi-qch/base-admin.svg?style=social
https://gitee.com/huanzi-qch/base-admin/badge/star.svg
巧了
巧了嘛这不是，把从博客园备份下来的《SpringBoot系列》、《SpringCloud系列》也直接丢到Gitee Pages服务，直接用我们封装好的docsify脚本，不就正好可以做成在线文档了！
《SpringBoot系列》，https://huanzi-qch.gitee.io/spring-boot
《SpringCloud系列》，https://huanzi-qch.gitee.io/spring-cloud
后记
base-admin的文档，已经提交到项目中，欢迎大家一起参与编辑
后续有空再分享更多骚操作！
版权声明
作者：huanzi-qch
内容出处：，
声明：本网站所收集的部分公开资料来源于互联网，转载的目的在于传递更多信息及用于网络分享，并不代表本站赞同其观点和对其真实性负责，也不构成任何其他建议。如果您发现网站上有侵犯您的知识产权的作品，请与我们取得联系，我们会及时修改或删除。文章链接：http://www.yixao.com/tech/29825.html
微信扫一扫
支付宝扫一扫
相关推荐
-
一步步成为优秀的后端开发工程师
学习一门编程语言 编程语言有很多种，对于刚开始进行后端开发的初学者，我建议您可以选择任何一种脚本语言开始，因为脚本语言可以解决很多实际问题，并且可以让您快速入门。如果您有一些前端知…
-
黑苹果与Windows系统时间不对（不同步）的解决办法
由于手贱把在macOS下Windows的D盘给分区了，本来是想给黑苹果单独弄出一个单独的数据盘的，然后操作不当，D盘的数据没了，好在D盘只有一些电影、Windows软件、游戏。 于…
-
如何注册国外的Apple ID，简单教程分享
有很多人想下载facebook、YouTube、Twitter、Tik Tok。但是这些软件在iPhone上大陆地区是不能下载的。所以很多人就想到了用国外的Apple ID来进行下…
-
如何在在最短的时间内高效率的学习Python？
你是否多次的自学Python开发，但是都倒在了自学的路上，从选择入门到选择放弃，浪费了不少的时间和money，遇见问题的时候百度找不到解决的方法，搜索百度答案也是五花八门。身边没有…
-
Ubuntu21.04发布，将原生支持AD功能
Ubuntu 21.04已经发布，代号为Hirsute Hippo，当前版本最大的亮点为原生集成AD功能，在Linux中，其实有很多方法支持LDAP、Kerberos PAM、NS…
-
Photoshop2021新功能恐怖如斯！
随着Adobe MAX创意盛会的开幕，Photoshop也迎来了最新的2021正式版更新，版本号也是更新到了22.0.0。 与之前的版相比，这次Adobe付出了很大的努力，带来了很…
-
微信小程序官网注册流程
登陆官网 https://mp.weixin.qq.com/?token=&lang=zh_CN 注册微信小程序账号 这里选择小程序即可 注册完毕验证邮箱即可 下载微信小…
-
微信公众号个人订阅号菜单怎么跳转链接？
个人订阅号和认证的订阅号、服务号相比，其中有一点不同之处就是自定义菜单不能跳转链接，需要认证的订阅号才能使用，而个人订阅号又不能申请认证，更别说第三方开发实现，因为没有此接口。用户…
-
如何完全抹盘全新安装macOS，2021最新教程
有时候我们想要把 Mac 硬盘完全抹掉后重新安装系统，比如在把这台 Mac 送人或者二手出掉时，或者遇到系统不稳定或有严重问题时。这样操作后的 Mac 就像一台刚买的新 Mac 一…
-
新版Edge浏览器2020新功能盘点：从蹒跚学步到羽翼渐丰
2020 年 1 月，微软发布了首个基于 Chromium 的 Edge 稳定版。在过去的 1 年时间里，微软不再优化其性能的同时还引入了非常多的新功能、新特性。在迈入 2021 …