2024-05-25 - Docs cleanup

Author: markbattistella

.github/scripts/release.js

@@ -31,8 +31,7 @@ packageData.version = newVersion;
 jsonfile.writeFileSync(packageFile, packageData, { spaces: 2 });
 
 const filesToUpdate = [
-    "./docs/dist/docsify-sidebar.js",
-    "./docs/dist/docsify-sidebar.min.js",
+    "./dist/docsify-sidebar.js",
     "./dist/docsify-sidebar.min.js"
 ];
 

.gitignore

@@ -3,5 +3,4 @@
 .DS_Store
 *babel.js
 *.min.js
-!docs/dist
-!docs/dist/*.min.js
+.gitattributes

.markdownlint.json

@@ -2,7 +2,7 @@
   "default": true,
   "MD013": false,
   "MD024": {
-    "allow_different_nesting": true
+    "siblings_only": true
   },
   "MD033": false,
   "MD041": false,

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 5.0.7 - Sat May 25 2024
+
+### Fixed
+
+- Documentation cleanup
 
 ## 5.0.6 - Mon May 22 2023
 

dist/docsify-sidebar.js

@@ -0,0 +1,184 @@
+/*! docsify-sidebar 5.0.7 | (c) Mark Battistella */
+; (function () {
+	'use strict';
+
+	const autoFooter = (hook, vm) => {
+		// Default options
+		const footerOptions = {
+			name: '',
+			url: '',
+			copyYear: '',
+			policy: true,
+			terms: true,
+			cookies: true,
+			customStyle: 'body'
+		};
+
+		// Extend defaults with user options
+		Object.assign(footerOptions, $docsify.autoFooter || {});
+
+		const isObject = (obj) => obj && obj.constructor === Object && Object.keys(obj).length > 0;
+
+		if (!isObject(footerOptions)) {
+			throw new Error('Sidebar-footer configuration is invalid or empty. Please check the $docsify.autoFooter config.');
+		}
+
+		// Auto-update the year
+		if (!footerOptions.copyYear) {
+			footerOptions.copyYear = new Date().getFullYear();
+		}
+
+		// MARK: run with docsify init
+		hook.init(function () {
+
+			// -- initialise the options
+			// getFooter(footerOptions, $docsify.autoFooter || {});
+
+			// -- check the options for bool or string
+			if (typeof footerOptions.customStyle === "boolean" || typeof footerOptions.customStyle === "string") {
+
+				// -- dont continue if using custom styles
+				if ((typeof footerOptions.customStyle === "boolean" && footerOptions.customStyle === true)) {
+					return;
+				}
+
+				// -- global style
+				let style = `#mb-footer { border-top: 1px solid; font-size: 0.8em; line-height: 1.5; transition: all var(--sidebar-transition-duration) ease-out; }`;
+
+				// -- custom style for sidebar
+				if ((typeof footerOptions.customStyle === "boolean" && footerOptions.customStyle === false) ||
+					(footerOptions.customStyle === "sidebar")
+				) {
+					style += `#mb-footer { padding-top: 1.5rem; margin-top: 1.5rem; } #mb-footer .footer-text, #mb-footer .footer-text a { font-weight: bold; }`;
+				}
+
+				// -- custom style for sidebar
+				if (footerOptions.customStyle === "body") {
+
+					// --> if there is a sidebar
+					if ($docsify.loadSidebar || $docsify.loadSidebar === null || !$docsify.hideSidebar) {
+						style += `body #mb-footer { margin-left: var(--sidebar-width); } body.close #mb-footer { margin-left: 0; }`;
+					}
+
+					// --> standard
+					style += `#mb-footer { padding: 1.5rem; } #mb-footer .footer-container { max-width: var(--content-max-width); margin: 0 auto; } #mb-footer .footer-container { display: grid; grid-template-columns: auto auto; } #mb-footer .footer-container a { margin-left: 2em; } #mb-footer .footer-link { text-align: right; }`;
+
+					// --> media queries
+					style += `@media (max-width: 680px) { #mb-footer .footer-container { grid-template-columns: auto; }#mb-footer .footer-text, #mb-footer .footer-link { text-align: center; } } @media (max-width: 400px) { #mb-footer .footer-text, #mb-footer .footer-link { text-align: left; } #mb-footer span { display: block; } #mb-footer .footer-container a { margin: 0; } }`;
+				}
+
+				// create the variables
+				const head = document.querySelector("head"),
+					sheet = document.createElement("style");
+
+				// add to the page
+				head.appendChild(sheet);
+				sheet.appendChild(document.createTextNode(style));
+			}
+		});
+
+		// MARK: after the HTML appended to DOM
+		hook.doneEach(function () {
+
+			// set the scope
+			const contentScope = document.getElementById("mb-footer");
+
+			// if the scope is empty
+			if (!contentScope) { return; }
+
+			//
+			// MARK: - add the info
+			//
+
+			// get the date
+			const date = new Date().getFullYear(),
+
+				// -- url building
+				baseUrl = window.location.origin + window.location.pathname + "#/",
+
+				// -- check if link is internal or external
+				isExternalLink = (url) => {
+					const tmp = document.createElement('a');
+					tmp.href = url;
+					return tmp.host !== window.location.host;
+				},
+
+				// -- link generator
+				createLink = (option, linkText, defaultLink, className) => {
+					let result = "";
+
+					// --> only accept bool and string
+					if (typeof option === "boolean" || typeof option === "string") {
+
+						// --> if bool, and true
+						if (typeof option === "boolean" && option) {
+
+							// --> use the default options
+							result = `<a href="${baseUrl + defaultLink}">${linkText}</a>`;
+
+							// --> if it is a string url
+						} else if (typeof option === "string") {
+
+							// --> is the link external
+							result = isExternalLink(option)
+
+								// --> if external, add the _blank
+								? `<a target="_blank" href="${option}">${linkText}</a>`
+
+								// --> if internal, then add the page name
+								: `<a href="${baseUrl + option}">${linkText}</a>`;
+						}
+					}
+
+					// --> if the result is not empty
+					if (result) {
+
+						// --> create the class name
+						const classname = `${className.toLowerCase().replace(/\s+/g, '-')}`;
+
+						// -- compile the elements
+						result = `<span class="${classname}">${result}</span>`;
+					}
+
+					return result;
+				},
+
+				// MARK: - html elements
+
+				divclose = `</div>`,
+
+				// -- divs
+				div1open = `<div class="footer-container">`,
+				div2open = `<div class="footer-text">`,
+				div3open = `<div class="footer-link">`,
+
+				// -- text
+				copyright = (
+					`<span class="footer-text-copyright">Copyright &copy; ${footerOptions.copyYear && footerOptions.copyYear <= date
+						? `${footerOptions.copyYear}${footerOptions.copyYear < date ? "&#45;" + date : ""}`
+						: date
+					}</span>`
+				),
+				author = createLink(footerOptions.url, footerOptions.name, '', 'footer-text-author'),
+
+				// -- links
+				policyURL = createLink(footerOptions.policy, 'Policy', '_policy', 'footer-links-policy'),
+				termsURL = createLink(footerOptions.terms, 'Terms', '_terms', 'footer-links-terms'),
+				cookiesURL = createLink(footerOptions.cookies, 'Cookies', '_cookies', 'footer-links-cookies'),
+
+				// output
+				output = (
+					div1open +
+					div2open + copyright + author + divclose +
+					div3open + policyURL + termsURL + cookiesURL + divclose +
+					divclose
+				);
+
+			contentScope.innerHTML = output;
+		});
+	}
+
+	// Register the plugin
+	$docsify = $docsify || {};
+	$docsify.plugins = [].concat(autoFooter, $docsify.plugins || []);
+}());