Major Updates: - Rewrote all docs in beginner-friendly 'ELI5' language - Created docs index with user journey navigation - Added complete getting-started guide for novice users - Set up GitHub Container Registry (GHCR) automation - Configured GitHub Pages deployment for documentation Documentation: - docs/index.md - Central navigation hub - docs/getting-started.md - Step-by-step beginner guide - docs/github-setup.md - CI/CD setup instructions - README.md - Complete rewrite in accessible language - CONTRIBUTING.md - Contributor guidelines - Multiple comprehensive API and schema docs CI/CD Workflows: - .github/workflows/docker-build.yml - Multi-platform builds to GHCR - .github/workflows/docs.yml - Automated docs deployment to Pages - Supports main (latest), development (dev), and version tags - Automated testing of built images - Beautiful documentation site with dark theme Benefits: - Zero barrier to entry for new users - Automated Docker builds (AMD64 + ARM64) - Professional documentation site - No Docker Hub account needed (uses GHCR) - Complete CI/CD pipeline All 7 implementation phases complete - project is production ready!
88 lines
2.6 KiB
JavaScript
88 lines
2.6 KiB
JavaScript
/* eslint-disable */
|
|
var jumpToCode = (function init() {
|
|
// Classes of code we would like to highlight in the file view
|
|
var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
|
|
|
|
// Elements to highlight in the file listing view
|
|
var fileListingElements = ['td.pct.low'];
|
|
|
|
// We don't want to select elements that are direct descendants of another match
|
|
var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
|
|
|
|
// Selector that finds elements on the page to which we can jump
|
|
var selector =
|
|
fileListingElements.join(', ') +
|
|
', ' +
|
|
notSelector +
|
|
missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
|
|
|
|
// The NodeList of matching elements
|
|
var missingCoverageElements = document.querySelectorAll(selector);
|
|
|
|
var currentIndex;
|
|
|
|
function toggleClass(index) {
|
|
missingCoverageElements
|
|
.item(currentIndex)
|
|
.classList.remove('highlighted');
|
|
missingCoverageElements.item(index).classList.add('highlighted');
|
|
}
|
|
|
|
function makeCurrent(index) {
|
|
toggleClass(index);
|
|
currentIndex = index;
|
|
missingCoverageElements.item(index).scrollIntoView({
|
|
behavior: 'smooth',
|
|
block: 'center',
|
|
inline: 'center'
|
|
});
|
|
}
|
|
|
|
function goToPrevious() {
|
|
var nextIndex = 0;
|
|
if (typeof currentIndex !== 'number' || currentIndex === 0) {
|
|
nextIndex = missingCoverageElements.length - 1;
|
|
} else if (missingCoverageElements.length > 1) {
|
|
nextIndex = currentIndex - 1;
|
|
}
|
|
|
|
makeCurrent(nextIndex);
|
|
}
|
|
|
|
function goToNext() {
|
|
var nextIndex = 0;
|
|
|
|
if (
|
|
typeof currentIndex === 'number' &&
|
|
currentIndex < missingCoverageElements.length - 1
|
|
) {
|
|
nextIndex = currentIndex + 1;
|
|
}
|
|
|
|
makeCurrent(nextIndex);
|
|
}
|
|
|
|
return function jump(event) {
|
|
if (
|
|
document.getElementById('fileSearch') === document.activeElement &&
|
|
document.activeElement != null
|
|
) {
|
|
// if we're currently focused on the search input, we don't want to navigate
|
|
return;
|
|
}
|
|
|
|
switch (event.which) {
|
|
case 78: // n
|
|
case 74: // j
|
|
goToNext();
|
|
break;
|
|
case 66: // b
|
|
case 75: // k
|
|
case 80: // p
|
|
goToPrevious();
|
|
break;
|
|
}
|
|
};
|
|
})();
|
|
window.addEventListener('keydown', jumpToCode);
|