Skip to content

Commit

Permalink
Fix anchors with <code> in table of content
Browse files Browse the repository at this point in the history
  • Loading branch information
@mateossh
mateossh committed Nov 15, 2021
1 parent ec0bb79 commit abe4c46
Show file tree
Hide file tree
Showing 3 changed files with 327 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<meta name="twitter:card" content="summary_large_image">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css" title="light">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css" media="(prefers-color-scheme: dark)">
<link rel="stylesheet" href="//unpkg.com/docsify-toc@1.0.0/dist/toc.css">
<link rel="stylesheet" href="toc.css" />
<link rel="stylesheet" href="qmk_custom_light.css">
<link rel="stylesheet" href="qmk_custom_dark.css" media="(prefers-color-scheme: dark)">
</head>
Expand Down Expand Up @@ -154,7 +154,7 @@
<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
<script src="//unpkg.com/docsify-tabs@1"></script>
<script src="//unpkg.com/docsify-copy-code@2"></script>
<script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>
<script src="toc.js"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script>
Expand Down
131 changes: 131 additions & 0 deletions docs/toc.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
/*
MIT License
Copyright (c) 2019 Andric LibreSinn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
.content {
display: flex;
flex-direction: row-reverse;
justify-content: center;
}
.markdown-section {
/* flex: 1 1 0%; */
margin: 0 48px;
}
.nav {
width: var(--toc-width, 700px);
/* align-self: flex-start;
flex: 0 0 auto; */
}
aside.nav.nothing {
width: 0;
}

.page_toc {
position: fixed;
border-left-style: solid;
border-left-width: 1px;
border-left-color: rgba(0, 0, 0, 0.07);
border-image-slice: 1;
padding-left: 5px;
}

.page_toc a > * {
pointer-events: none;
}

.page_toc code {
background-color: #f8f8f8;
border-radius: 2px;
color: #e96900;
font-family: 'Roboto Mono', Monaco, courier, monospace;
font-size: 0.8rem;
margin: 0 2px;
padding: 3px 5px;
}

.page_toc p.title {
margin: 0px 0 0px 9px;
padding-bottom: 5px;
font-weight: 600;
font-size: 1.2em;
}
.page_toc .anchor:hover:after {
content: "";
}

.page_toc ul {
list-style-type: none;
margin-top: 0px;
padding-left: 10px;
color: var(--text-color-base, black);
text-decoration: none;
font-weight: 300;
line-height: 1.6em;
}

.page_toc ul a:hover span {
color: var(--text-color-tertiary, #42b983);
border-bottom: none !important;
text-decoration:none !important;
}

.page_toc ul a {
color: var(--text-color-base, black);
text-decoration: none;
font-weight: 300;
line-height: 1.6em;
}

@media screen and (max-width: 1300px) {
.page_toc {
position: relative;
left: 0;
top: -20px;
padding: 10px 0;
border: none;
border-bottom: 1px solid #ddd;
font-size: 1.0em;
}
.page_toc a:before {
content: "- ";
}
.nav {
margin: 0 auto;
width: 800px;
}
.page_toc p.title {
font-weight: 300;
font-size: 1.8em;
}
.content {
display: block;
}
.markdown-section {
margin: 0 auto;
}
}

.page_toc .active {
border-left: 5px solid;
color: var(--theme-color, #42b983);
padding-left: 10px;
}
194 changes: 194 additions & 0 deletions docs/toc.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
/*
MIT License
Copyright (c) 2019 Andric LibreSinn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

var defaultOptions = {
headings: 'h1, h2',
scope: '.markdown-section',

// To make work
title: 'Contents',
listType: 'ul',
}

// Element builders
var tocHeading = function(Title) {
return document.createElement('h2').appendChild(
document.createTextNode(Title)
)
}

var aTag = function(src) {
var a = document.createElement('a');
var content = src.firstChild.innerHTML;

// Use this to clip text w/ HTML in it.
// https://github.com/arendjr/text-clipper
a.innerHTML = content;
a.href = src.firstChild.href;
a.onclick = tocClick

// In order to remove this gotta fix the styles.
a.setAttribute('class', 'anchor');

return a
};

var tocClick = function(e) {
var divs = document.querySelectorAll('.page_toc .active');

// Remove the previous classes
[].forEach.call(divs, function(div) {
div.setAttribute('class', 'anchor')
});

// Make sure this is attached to the parent not itself
e.currentTarget.setAttribute('class', 'active')
};

var createList = function(wrapper, count) {
while (count--) {
wrapper = wrapper.appendChild(
document.createElement('ul')
);

if (count) {
wrapper = wrapper.appendChild(
document.createElement('li')
);
}
}

return wrapper;
};

//------------------------------------------------------------------------

var getHeaders = function(selector) {
var headings2 = document.querySelectorAll(selector);
var ret = [];

[].forEach.call(headings2, function(heading) {
ret = ret.concat(heading);
});

return ret;
};

var getLevel = function(header) {
var decs = header.match(/\d/g);

return decs ? Math.min.apply(null, decs) : 1;
};

var jumpBack = function(currentWrapper, offset) {
while (offset--) {
currentWrapper = currentWrapper.parentElement;
}

return currentWrapper;
};

var buildTOC = function(options) {
var ret = document.createElement('ul');
var wrapper = ret;
var lastLi = null;
var selector = options.scope + ' ' + options.headings
var headers = getHeaders(selector).filter(h => h.id);

headers.reduce(function(prev, curr, index) {
var currentLevel = getLevel(curr.tagName);
var offset = currentLevel - prev;

wrapper = (offset > 0)
? createList(lastLi, offset)
: jumpBack(wrapper, -offset * 2)

wrapper = wrapper || ret;

var li = document.createElement('li');

wrapper.appendChild(li).appendChild(aTag(curr));

lastLi = li;

return currentLevel;
}, getLevel(options.headings));

return ret;
};

// Docsify plugin functions
function plugin(hook, vm) {
var userOptions = vm.config.toc;

hook.mounted(function () {
var content = window.Docsify.dom.find(".content");
if (content) {
var nav = window.Docsify.dom.create("aside", "");
window.Docsify.dom.toggleClass(nav, "add", "nav");
window.Docsify.dom.before(content, nav);
}
});

hook.doneEach(function () {
var nav = document.querySelectorAll('.nav')[0]
var t = Array.from(document.querySelectorAll('.nav'))

if (!nav) {
return;
}

const toc = buildTOC(userOptions);

// Just unset it for now.
if (!toc.innerHTML) {
nav.innerHTML = null
return;
}

// Fix me in the future
var title = document.createElement('p');
title.innerHTML = userOptions.title;
title.setAttribute('class', 'title');

var container = document.createElement('div');
container.setAttribute('class', 'page_toc');

container.appendChild(title);
container.appendChild(toc);

// Existing TOC
var tocChild = document.querySelectorAll('.nav .page_toc');

if (tocChild.length > 0) {
tocChild[0].parentNode.removeChild(tocChild[0]);
}

nav.appendChild(container);
});
}

// Docsify plugin options
window.$docsify['toc'] = Object.assign(defaultOptions, window.$docsify['toc']);
window.$docsify.plugins = [].concat(plugin, window.$docsify.plugins);

0 comments on commit abe4c46

Please sign in to comment.