1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2025-02-12 11:46:10 +02:00

Add "Edit on GitHub" button to docs

This commit is contained in:
DarthSim 2019-10-15 18:08:32 +06:00
parent 2d7e26fb18
commit cf5673d3b6
3 changed files with 73 additions and 1 deletions

View File

@ -0,0 +1,43 @@
; (function (win) {
win.EditOnGithubPlugin = {}
function create(docBase, docEditBase, title) {
title = title || 'Edit on github'
docEditBase = docEditBase || docBase.replace(/\/blob\//, '/edit/')
function editDoc(event, vm) {
var docName = vm.route.file
if (docName) {
var editLink = docEditBase + docName
window.open(editLink)
event.preventDefault()
return false
} else {
return true
}
}
win.EditOnGithubPlugin.editDoc = editDoc
return function (hook, vm) {
win.EditOnGithubPlugin.onClick = function (event) {
EditOnGithubPlugin.editDoc(event, vm)
}
var header = [
'<a class="github-edit-btn" title="Edit on GitHub" href="',
docBase,
'" target="_blank" onclick="EditOnGithubPlugin.onClick(event)">',
'Edit on <strong>GitHub</strong>',
'</a>'
].join('')
hook.afterEach(function (html) {
return html + header
})
}
}
win.EditOnGithubPlugin.create = create
})(window)

View File

@ -78,3 +78,28 @@
height: 1em;
vertical-align: middle;
}
.github-edit-btn {
display: block;
position: fixed;
bottom: 0;
right: 10px;
border-radius: 10px 10px 0 0;
background-color: var(--link-color);
color: var(--base-color) !important;
text-decoration: none !important;
font-size: .8em;
padding: 0.2em 1em;
opacity: 0.75;
z-index: 999;
}
.github-edit-btn:hover {
opacity: 1;
}
@media (max-width: 768px) {
.github-edit-btn {
display: none;
}
}

View File

@ -36,6 +36,7 @@
<div class="loading__spinner"></div>
</div>
</div>
<script src="assets/docsify-edit-link.js"></script>
<script>
window.$docsify = {
name: '<img style="width:90%" title="imgproxy logo" src="/assets/logo.svg" >',
@ -46,7 +47,10 @@
search: {
namespace: 'docs-imgproxy',
depth: 6
}
},
plugins: [
EditOnGithubPlugin.create('https://github.com/imgproxy/imgproxy/blob/master/docs/')
]
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>