@markbattistella/docsify-sidebarfooter 4.0.0 → 5.0.1

package/README.md

@@ -1,23 +1,6 @@
-<div align="center">
+# docsify.js sidebar footer
 
-# docsify-sidebarfooter
-
-![Github2npm](https://github.com/markbattistella/docsify-sidebarfooter/workflows/gh2npm/badge.svg?event=registry_package) ![npm (scoped)](https://img.shields.io/npm/v/@markbattistella/docsify-sidebarfooter) ![GitHub](https://img.shields.io/github/license/markbattistella/docsify-sidebarfooter) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@markbattistella/docsify-sidebarfooter)
-
----
-
-[![](https://img.shields.io/badge/%20-@markbattistella-blue?logo=paypal&style=for-the-badge)](https://www.paypal.me/markbattistella/6AUD)
-[![](https://img.shields.io/badge/%20-buymeacoffee-black?logo=buy-me-a-coffee&style=for-the-badge)](https://www.buymeacoffee.com/markbattistella)
-
-[![](https://img.shields.io/badge/demo-@markbattistella/docsify--sidebarfooter-1E5749?style=for-the-badge)](https://markbattistella.github.io/docsify-sidebarfooter/)
-
-</div>
-
----
-
-This plugin is designed to create a footer area at the base of your sidebar (or page) where you can list a copyright year (range), your name or company with a URL, and links to a privacy policy, terms of service, and a cookies policy.
-
----
+This plugin enhances your website's sidebar or page by creating a footer area where you can display important information. It automatically updates the copyright year or range, allows you to include your name or company with a URL, and provides links to a privacy policy, terms of service, and cookies policy pages. By utilising this plugin, you can easily showcase relevant legal information, personalise your website, and promote transparency and compliance.
 
 ## Installation
 
@@ -25,7 +8,7 @@ This plugin is designed to create a footer area at the base of your sidebar (or
 
 Assuming you have a working [docsify](https://docsify.js.org/) framework set up, it is easy to use the plugin.
 
-1. Add the following script tag to your `index.html` via either CDN or downloading it and using it locally:
+1. Add one of the following script tags to your `index.html` via either CDN or downloading it and using it locally:
 
     ```html
     <!-- unpkg.com -->
@@ -35,7 +18,7 @@ Assuming you have a working [docsify](https://docsify.js.org/) framework set up,
     <script src="https://cdn.jsdelivr.net/npm/@markbattistella/docsify-sidebarfooter@latest"></script>
 
     <!-- locally -->
-    <script src="docsify-sidebarfooter.min.js"></script>
+    <script src="docsify-sidebar.min.js"></script>
     ```
 
 1. In docsify setup configure the plugin:
@@ -44,76 +27,153 @@ Assuming you have a working [docsify](https://docsify.js.org/) framework set up,
     <script>
     window.$docsify = {
       autoFooter: {
-        name:       String,          // company display name (required)
-        copyYear:   Int,             // start copyright year (required)
-        url:        String,          // company url (optional)
-        policy:     Bool | String,   // show Privacy Policy (optional)
-        terms:      Bool | String,   // show Terms of Service (optional)
-        cookies:    Bool | String,   // show Cookies Policy (optional)
-        onBody:     Bool             // if true it is on the main doc
+
+        // the name you wish to display as the copyright holder
+        name:        String,
+
+        // the URL (personal or company) which clicking the `name` goes to
+        url:         String,
+
+        // the start year of copyright
+        copyYear:    String,
+
+        // show the privacy policy link
+        policy:      Bool | String,
+
+        // show the terms of service link
+        terms:       Bool | String,
+
+        // show the cookies policy link
+        cookies:     Bool | String,
+
+        // use your own css styles or the built in ones
+        customStyle: Bool | String
       }
     };
     </script>
     ```
 
-### npm install
+### Additional files
+
+#### Default
 
-Or if you're using `npm` to manage your dependencies:
+If you set the `policy`, `terms`, or `cookies` options to `true` the URL links for those pages will look for the markdown files directly next to the `index.html` file:
 
-```sh
-npm i @markbattistella/docsify-sidebarfooter
+```js
+// ... other config
+policy: true,
+terms: true,
+cookies: true,
+// ... other config
 ```
 
-### Additional files
+```md
+- index.html      --> https://your-awesome-site.com/#/
+- _policy.md      --> https://your-awesome-site.com/#/_policy
+- _terms.md       --> https://your-awesome-site.com/#/_terms
+- _cookies.md     --> https://your-awesome-site.com/#/_cookies
+```
+
+#### Sub-folder
 
-If you are using the Privacy Policy, Terms of Service, or Cookie links, then add the files to the root (next to `index.html`). However, if you inputted strings make sure they are in the location of that path with the correct filename.
+However, if you enter a string it will append that to the base URL of your website:
+
+```js
+// ... other config
+policy: 'site/policy',
+terms: 'site/terms',
+cookies: 'site/cookies',
+// ... other config
+```
 
 ```md
-| docs/                      | docs/
-|-- index.html               |-- site/
-|-- _privacy.md              |---- privacy.md
-|-- _terms.md                |---- terms.md
-|-- _cookies.md              |---- cookies.md
+- index.html      --> https://your-awesome-site.com/#/
+- site/
+  \__ policy.md   --> https://your-awesome-site.com/#/site/policy
+  \__ terms.md    --> https://your-awesome-site.com/#/site/terms
+  \__ cookies.md  --> https://your-awesome-site.com/#/site/cookies
+```
+
+#### External links
+
+If you host your policy, terms, or cookies messages on an external website (or need to link to a parent company policy) you can add them in as the full URL:
+
+```js
+// ... other config
+policy: "https://my-other-website.com/policy",
+terms: "https://my-other-website.com/terms",
+cookies: "https://my-other-website.com/cookies",
+// ... other config
 ```
 
+These will open those pages in a new tab directly.
+
 ## Configuration
 
 There are some options available for the `docsify-sidebarfooter`:
 
-| setting    | required | type           | options                            |
-|------------|:--------:|----------------|------------------------------------|
-| `name`     | Y        | String         | your name or company               |
-| `copyYear` | Y        | String         | first year of copyright            |
-| `url`      | N        | String         | url you want the `name` to link to |
-| `policy`   | N        | Bool or String | path to `policy`                   |
-| `terms`    | N        | Bool or String | path to `terms`                    |
-| `cookies`  | N        | Bool or String | path to `cookies`                  |
-| `onBody` | N      | Bool           | display in the body not sidebar    |
+| Setting       | Type           | Options                            |
+|---------------|----------------|------------------------------------|
+| `name`        | String         | your name or company               |
+| `url`         | String         | url you want the `name` to link to |
+| `copyYear`    | String         | first year of copyright            |
+| `policy`      | Bool or String | - `false` hides it from the site<br/>- `true` defaults to `_policy.md`<br/>- a custom string will direct to that |
+| `terms`       | Bool or String | - `false` hides it from the site<br/>- `true` defaults to `_terms.md`<br/>- a custom string will direct to that |
+| `cookies`     | Bool or String | - `false` hides it from the site<br/>- `true` defaults to `_cookies.md`<br/>- a custom string will direct to that |
+| `customStyle` | Bool or String | - `false` uses in-built css (sidebar styled)<br/>- `true` applies no styles, you can create your own<br/>- `sidebar` uses the in-built css designed for the sidebar<br/>- `body` uses the in-built css designed for the body |
 
 ## Usage
 
+### Sidebar
+
 At the bottom of your `_sidebar.md` file add the following code:
 
 ```html
 <footer id="mb-footer"></footer>
 ```
 
-## Contributing
-
-1. Clone the repo:
-
-    `git clone https://github.com/markbattistella/docsify-sidebarFooter.git`
+### Body
 
-2. Create your feature branch:
+Under the `<div id="app"></div>` in your `index.html` file, add the following code:
 
-    `git checkout -b my-feature`
+```html
+<footer id="mb-footer"></footer>
+```
 
-3. Commit your changes:
+## Styling
 
-    `git commit -am 'Add some feature'`
+The links container is sectioned into different classes for you to customise as much (or little) as you wish.
 
-4. `Push` to the branch:
+```html
+<footer id="mb-footer">
+  <div class="footer-container">
+    <div class="footer-text">
+      <span class="footer-text-copyright">
+        Copyright © YYYY-YYYY
+      </span>
+      <span class="footer-text-author">
+        <a target="_blank" href="">Your website name</a>
+      </span>
+    </div>
+    <div class="footer-link">
+      <span class="footer-links-policy">
+        <a href="">Policy</a>
+      </span>
+      <span class="footer-links-terms">
+        <a href="">Terms</a>
+      </span>
+      <span class="footer-links-cookies">
+        <a href="">Cookies</a>
+      </span>
+    </div>
+  </div>
+</footer>
+```
 
-    `git push origin my-new-feature`
+## Contributing
 
+1. Clone the repo:<br>`git clone https://github.com/markbattistella/docsify-sidebarFooter.git`
+2. Create your feature branch:<br>`git checkout -b my-feature`
+3. Commit your changes:<br>`git commit -am 'Add some feature'`
+4. `Push` to the branch:<br>`git push origin my-new-feature`
 5. Submit the `pull` request

package/dist/docsify-sidebar.js

@@ -0,0 +1,220 @@
+/*! docsify-sidebarFooter.js v5.0.1 | (c) Mark Battistella */
+'use strict';
+
+// MARK: - check if object exists and is not empty
+function doesObjectExists(obj) {
+	return (
+		obj !== undefined &&
+		obj !== null &&
+		obj.constructor === Object &&
+		Object.keys(obj).length > 0
+	);
+}
+
+
+// MARK: - update the `options` object
+function getFooter(options) {
+
+	// -- get this year
+	let date = new Date().getFullYear();
+
+	// -- update the variables
+	options.name ? options.name : null;
+	options.url ? options.url : null;
+	options.copyYear ? options.copyYear : date;
+	options.policy ? options.policy : false;
+	options.terms ? options.terms : false;
+	options.cookies ? options.cookies : false;
+	options.customStyle ? options.customStyle : false;
+}
+
+
+// defaults - and setup
+const options = {
+	name:        '',
+	url:         '',
+	copyYear:    '',
+	policy:      true,
+	terms:       true,
+	cookies:     true,
+	customStyle: false
+};
+
+
+// -- run the function
+function autoFooter(hook, vm) {
+
+	// MARK: run with docsify init
+	hook.init(function () {
+
+		// -- initialise the options
+		getFooter(options);
+
+
+		// -- check the options for bool or string
+		if (typeof options.customStyle === "boolean" || typeof options.customStyle === "string") {
+
+			// -- dont continue if using custom styles
+			if ((typeof options.customStyle === "boolean" && options.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 options.customStyle === "boolean" && options.customStyle === false) ||
+				(options.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 (options.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; ${
+					options.copyYear && options.copyYear <= date
+						? `${options.copyYear}${options.copyYear < date ? "&#45;" + date : ""}`
+						: date
+				}</span>`
+			),
+			author = createLink( options.url, options.name, '', 'footer-text-author'),
+
+			// -- links
+			policyURL = createLink(options.policy, 'Policy', '_policy', 'footer-links-policy'),
+			termsURL = createLink(options.terms, 'Terms', '_terms', 'footer-links-terms' ),
+			cookiesURL = createLink(options.cookies, 'Cookies', '_cookies', 'footer-links-cookies'),
+
+			// output
+			output = (
+				div1open +
+					div2open + copyright + author +	divclose +
+					div3open + policyURL + termsURL + cookiesURL + divclose +
+				divclose
+			);
+
+		contentScope.innerHTML = output;
+	});
+}
+
+
+// MARK: - check options is defined and not empty
+if (typeof options !== 'undefined' && doesObjectExists(options)) {
+
+	// -- find footer plugin options
+	window.$docsify.autoFooter = Object.assign(
+		options,
+		window.$docsify.autoFooter
+	);
+	window.$docsify.plugins = [].concat(autoFooter, window.$docsify.plugins);
+
+} else {
+
+	// -- log the error
+	console.error(
+		"ERROR: sidebar-footer configuration not set" + "\n" +
+		"This error appears when:" + "\n" +
+		"  - the `autoSidebar` not found index.html file" + "\n" +
+		"  - the `autoSidebar` is empty"
+	);
+}

package/dist/docsify-sidebar.min.js

@@ -0,0 +1,2 @@
+/* docsify-sidebarFooter.js v5.0.1 | (c) Mark Battistella */
+"use strict";function doesObjectExists(o){return null!=o&&o.constructor===Object&&0<Object.keys(o).length}function getFooter(o){(new Date).getFullYear();o.name,o.url,o.copyYear,o.policy,o.terms,o.cookies,o.customStyle}var options={name:"",url:"",copyYear:"",policy:!0,terms:!0,cookies:!0,customStyle:!1};function autoFooter(o,t){o.init(function(){var o,t,e;getFooter(options),"boolean"!=typeof options.customStyle&&"string"!=typeof options.customStyle||"boolean"==typeof options.customStyle&&!0===options.customStyle||(o="#mb-footer { border-top: 1px solid; font-size: 0.8em; line-height: 1.5; transition: all var(--sidebar-transition-duration) ease-out; }",("boolean"==typeof options.customStyle&&!1===options.customStyle||"sidebar"===options.customStyle)&&(o+="#mb-footer { padding-top: 1.5rem; margin-top: 1.5rem; } #mb-footer .footer-text, #mb-footer .footer-text a { font-weight: bold; }"),"body"===options.customStyle&&(!$docsify.loadSidebar&&null!==$docsify.loadSidebar&&$docsify.hideSidebar||(o+="body #mb-footer { margin-left: var(--sidebar-width); } body.close #mb-footer { margin-left: 0; }"),o+="#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 (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; } }"),t=document.querySelector("head"),e=document.createElement("style"),t.appendChild(e),e.appendChild(document.createTextNode(o)))}),o.doneEach(function(){var r,a,o,t,e,n,i,s,c=document.getElementById("mb-footer");c&&(t=(new Date).getFullYear(),r=window.location.origin+window.location.pathname+"#/",a=function(o){var t=document.createElement("a");return t.href=o,t.host!==window.location.host},s=function(o,t,e,n){var i="";return"boolean"!=typeof o&&"string"!=typeof o||("boolean"==typeof o&&o?i='<a href="'.concat(r+e,'">').concat(t,"</a>"):"string"==typeof o&&(i=(a(o)?'<a target="_blank" href="'.concat(o,'">'):'<a href="'.concat(r+o,'">')).concat(t,"</a>"))),i&&(e="".concat(n.toLowerCase().replace(/\s+/g,"-")),i='<span class="'.concat(e,'">').concat(i,"</span>")),i},o="</div>",t='<span class="footer-text-copyright">Copyright &copy; '.concat(options.copyYear&&options.copyYear<=t?"".concat(options.copyYear).concat(options.copyYear<t?"&#45;"+t:""):t,"</span>"),e=s(options.url,options.name,"","footer-text-author"),n=s(options.policy,"Policy","_policy","footer-links-policy"),i=s(options.terms,"Terms","_terms","footer-links-terms"),s=s(options.cookies,"Cookies","_cookies","footer-links-cookies"),c.innerHTML='<div class="footer-container"><div class="footer-text">'+t+e+o+'<div class="footer-link">'+n+i+s+o+o)})}void 0!==options&&doesObjectExists(options)?(window.$docsify.autoFooter=Object.assign(options,window.$docsify.autoFooter),window.$docsify.plugins=[].concat(autoFooter,window.$docsify.plugins)):console.error("ERROR: sidebar-footer configuration not set\nThis error appears when:\n  - the `autoSidebar` not found index.html file\n  - the `autoSidebar` is empty");

package/package.json

@@ -1,25 +1,32 @@
 {
 	"name": "@markbattistella/docsify-sidebarfooter",
-	"version": "4.0.0",
+	"version": "5.0.1",
 	"description": "Add a footer notice for Docsify.js",
-	"main": "dist/docsify-sidebarFooter.min.js",
+	"main": "./dist/docsify-sidebar.min.js",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/markbattistella/docsify-sidebarFooter.git"
 	},
-	"author": "Mark Battistella",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/markbattistella/docsify-sidebarFooter/issues"
-	},
-	"homepage": "https://github.com/markbattistella/docsify-sidebarFooter#readme",
+	"scripts": {},
+	"unpkg": "./dist/docsify-sidebar.min.js",
+	"jsdelivr": "./dist/docsify-sidebar.min.js",
 	"keywords": [
 		"footer",
 		"copyright",
 		"privacy policy",
 		"terms of service",
+		"terms and conditions",
+		"terms",
+		"policy",
+		"cookie",
 		"cookie policy",
 		"docsify",
 		"docsify plugin"
-	]
+	],
+	"author": "Mark Battistella",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/markbattistella/docsify-sidebar-footer/issues"
+	},
+	"homepage": "https://footer.docsify.markbattistella.com"
 }

package/dist/docsify-sidebarFooter.js

@@ -1,281 +0,0 @@
-/*! docsify-sidebarFooter.js v4.0.0 | (c) Mark Battistella */
-'use strict';
-
-function getFooter( footerOptions ) {
-
-	// if it is empty
-	if(
-		!footerOptions.name      ||
-		!footerOptions.copyYear
-	) {
-		return 'No config set'
-	}
-
-	// get this year
-	let date = new Date().getFullYear();
-
-	// create the array variables
-	let name		= footerOptions.name ?
-									footerOptions.name : null;
-	let url			= footerOptions.url ?
-									footerOptions.url : null;
-	let copyYear	= footerOptions.copyYear ?
-									footerOptions.copyYear : date;
-    let policy		= footerOptions.policy ?
-									footerOptions.policy : null;
-	let terms		= footerOptions.terms ?
-									footerOptions.terms : null;
-	let cookies		= footerOptions.cookies ?
-									footerOptions.cookies : null;
-	let onBody		= footerOptions.onBody ?
-									footerOptions.onBody : false;
-
-	// build the array
-	var outputArray = [
-		name,
-		url,
-		copyYear,
-		policy,
-		terms,
-		cookies,
-		onBody
-	];
-
-	return outputArray;
-}
-
-// defaults - and setup
-const footerOptions = {
-	name:		'',    // required
-	url:		'',    // optional
-	copyYear:	'',    // required
-	policy:		false, // optional
-	terms:		false, // optional
-	cookies:	false, // optional
-	onBody:		false  // optional
-};
-
-
-// the function
-function autoFooter( hook, vm ) {
-
-	// get the variables from the cofig
-	const	footerOptionsArray = getFooter( footerOptions ),
-
-			// create them easier to read
-			arrayName		= footerOptionsArray[0],
-			arrayUrl		= footerOptionsArray[1],
-			arrayCopyYear	= footerOptionsArray[2],
-			arrayPolicy		= footerOptionsArray[3],
-			arrayTerms		= footerOptionsArray[4],
-			arrayCookies	= footerOptionsArray[5],
-			arraySidebar	= footerOptionsArray[6];
-
-	// when script starts running
-	hook.init(function() {
-
-
-
-		function rgb2hex( rgb ) {
-		    rgb = rgb.match(/^rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*(\d+))?\)$/);
-		    function hex(x) {
-		        return ("0" + parseInt(x).toString(16)).slice(-2);
-		    }
-		    return "#" + hex(rgb[1]) + hex(rgb[2]) + hex(rgb[3]);
-		}
-
-
-
-		// detect if we have a light or dark text
-		// -- https://stackoverflow.com/a/35970186/1086990
-		function invertColor( hex, bw ) {
-			if (hex.indexOf('#') === 0) {
-				hex = hex.slice(1);
-			}
-
-			// convert 3-digit hex to 6-digits.
-			if( hex.length === 3 ) {
-				hex = hex[0] + hex[0] + hex[1] + hex[1] + hex[2] + hex[2];
-			}
-
-			// no background colour: default white
-			if( hex.length === 0 ) {
-				hex = "FFFFFF"
-			}
-
-			// not HEX or greater than 6 chars
-    		if( hex.length !== 6 ) {
-
-				hex = rgb2hex( hex );
-
-
-				// throw new Error('Invalid HEX color.');
-			}
-
-			// get the RGB values
-    		var r = parseInt(hex.slice(0, 2), 16),
-        		g = parseInt(hex.slice(2, 4), 16),
-        		b = parseInt(hex.slice(4, 6), 16);
-
-			//
-			if( bw ) {
-        		return (r * 0.299 + g * 0.587 + b * 0.114) > 186
-            		? '#000000'
-            		: '#FFFFFF';
-    		}
-
-			const zeros = new Array(2).join('0');
-
-    		// invert color components
-			r = (zeros + (( 255 - r ).toString(16))).slice(-2),
-			g = (zeros + (( 255 - g ).toString(16))).slice(-2),
-			b = (zeros + (( 255 - b ).toString(16))).slice(-2);
-
-
-    		// pad each with zeros and return
-			return "#" + r + g + b;
-		}
-
-
-		// add in the style
-		if( typeof arraySidebar === "boolean" && arraySidebar ) {
-
-			// create the variables
-			const	head	= document.querySelector( "head" ),
-					sheet	= document.createElement( "style" ),
-
-					// body background and inverse
-					bodyBG	= (document.body.style.backgroundColor === "" ? "#FFF" : document.body.style.backgroundColor ),
-					bodyIBG	= invertColor( bodyBG, true ),
-
-					// styling
-					style 	 = "#mb-footer { position: fixed; bottom: 0; left: 50%; border-radius: 10em 10em 0 0; max-width: var(--content-max-width, 800px); width: 100%; padding: 0 45px; text-align: center; box-shadow: 0 -1em 1em 0 rgba(0,0,0,0.05); transform: translateX(-50%); background: " + bodyBG + "; line-height: 2em; } #mb-footer, #mb-footer a { color: " + bodyIBG + "; } #mb-footer > div > div, #mb-footer > div a { display: inline-block; margin-right: 1em; } @media( max-width: 430px ){ #mb-footer { position: relative; left: auto; transform: none; } #mb-footer span { display: inline-block; } }";
-
-			// add to the page
-			head.appendChild( sheet );
-			sheet.appendChild( document.createTextNode( style ) );
-		}
-	});
-
-
-	// after initial completion
-	hook.doneEach(function() {
-
-		//
-		// MARK: - set the scope of the autoFooter
-		//
-
-		// set the scope
-		const contentScope = document.getElementById("mb-footer");
-
-		// if the scope is empty
-		if( !contentScope ) {
-			return;
-		}
-
-		// if the array doesnt have the minimum entries
-		if( footerOptionsArray === "No config set" ) {
-			return;
-		}
-
-
-		//
-		// MARK: - add the info
-		//
-
-		// get the date
-		const date = new Date().getFullYear(),
-
-			// url building
-			baseUrl = window.location.origin + window.location.pathname + "#/",
-
-			// divider
-			a = ( (typeof arraySidebar === "boolean" && arraySidebar) ? "" : "<hr/>"),
-
-			// create the footer
-			b = "<div style='font-size:70%;'>",
-
-				// copyright data
-				c = "<div>",
-
-					d = "&copy; ",
-
-					// get the start copy year
-					// --> if is empty OR greater than current year
-					e = ( (arrayCopyYear == null) || (arrayCopyYear > date) ? date : arrayCopyYear ),
-
-					// get the current year
-					// --> do we add the "-YYYY" range or not
-					f = ( (arrayCopyYear != null) && (arrayCopyYear < date) ? "&mdash;" + date : ""),
-
-				g = "</div>",
-
-				// company details
-				h = ( arrayUrl == null ? "<div>" :
-								"<a target='_blank' href='" + arrayUrl + "'>" ),
-
-					i = arrayName,
-
-				j = ( arrayUrl === "" ? "</div>" : "</a>" ),
-
-				// policy details
-                k = ( typeof arrayPolicy === "boolean" ||
-                      typeof arrayPolicy === "string"
-                    ) ?
-                        ( typeof arrayPolicy === "boolean" ?
-                            "<a href='" + baseUrl + "_policy'>Policy</a>"
-                        :
-                            "<a href='" + baseUrl + arrayPolicy + "'>Policy</a>"
-                    ) : "",
-
-                // terms details
-                l = ( typeof arrayTerms === "boolean" ||
-                      typeof arrayTerms === "string"
-                    ) ?
-                        ( typeof arrayTerms === "boolean" ?
-                            "<a href='" + baseUrl + "_terms'>Terms</a>"
-                        :
-                            "<a href='" + baseUrl + arrayTerms + "'>Terms</a>"
-                    ) : "",
-
-
-				// cookies details
-                m = ( typeof arrayCookies === "boolean" ||
-                      typeof arrayCookies === "string"
-                    ) ?
-                        ( typeof arrayTerms === "boolean" ?
-                            "<a href='" + baseUrl + "_cookies'>Cookies</a>"
-                        :
-                            "<a href='" + baseUrl + arrayCookies + "'>Cookies</a>"
-                    ) : "",
-
-
-			n = "</div>";
-
-
-		// output them to the body
-		const output =
-						a +				// ------------------
-						b +	c +			//
-						d + e + f + 	// (c) 1990-2020
-						g + 			//
-						h + i + j +		// Company Name
-						"<span>" +
-						k +				// Policy
-						l + 			// Terms
-						m +				// Cookies
-						"</span>" +
-						n;				//
-
-		contentScope.innerHTML = output;
-
-	});
-}
-
-
-// find footer plugin options
-window.$docsify.autoFooter = Object.assign(
-	footerOptions,
-	window.$docsify.autoFooter
-);
-window.$docsify.plugins = [].concat(autoFooter, window.$docsify.plugins);

package/dist/docsify-sidebarFooter.min.js

@@ -1,7 +0,0 @@
-/* docsify-sidebarFooter.js v4.0.0 | (c) Mark Battistella */
-function getFooter(b){if(!b.name||!b.copyYear)return"No config set";var w=(new Date).getFullYear();return[b.name?b.name:null,b.url?b.url:null,b.copyYear?b.copyYear:w,b.policy?b.policy:null,b.terms?b.terms:null,b.cookies?b.cookies:null,b.onBody?b.onBody:!1]}var footerOptions={name:"",url:"",copyYear:"",policy:!1,terms:!1,cookies:!1,onBody:!1};
-function autoFooter(b,w){var c=getFooter(footerOptions),y=c[0],t=c[1],g=c[2],l=c[3],h=c[4],u=c[5],m=c[6];b.init(function(){function n(a){function k(e){return("0"+parseInt(e).toString(16)).slice(-2)}a=a.match(/^rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*(\d+))?\)$/);return"#"+k(a[1])+k(a[2])+k(a[3])}function f(a,k){0===a.indexOf("#")&&(a=a.slice(1));3===a.length&&(a=a[0]+a[0]+a[1]+a[1]+a[2]+a[2]);0===a.length&&(a="FFFFFF");6!==a.length&&(a=n(a));var e=parseInt(a.slice(0,2),16),p=parseInt(a.slice(2,4),16),
-q=parseInt(a.slice(4,6),16);if(k)return 186<.299*e+.587*p+.114*q?"#000000":"#FFFFFF";var v=Array(2).join("0");e=(v+(255-e).toString(16)).slice(-2);p=(v+(255-p).toString(16)).slice(-2);q=(v+(255-q).toString(16)).slice(-2);return"#"+e+p+q}if("boolean"===typeof m&&m){var d=document.querySelector("head"),x=document.createElement("style"),r=""===document.body.style.backgroundColor?"#FFF":document.body.style.backgroundColor,z=f(r,!0);r="#mb-footer { position: fixed; bottom: 0; left: 50%; border-radius: 10em 10em 0 0; max-width: var(--content-max-width, 800px); width: 100%; padding: 0 45px; text-align: center; box-shadow: 0 -1em 1em 0 rgba(0,0,0,0.05); transform: translateX(-50%); background: "+
-r+"; line-height: 2em; } #mb-footer, #mb-footer a { color: "+z+"; } #mb-footer > div > div, #mb-footer > div a { display: inline-block; margin-right: 1em; } @media( max-width: 430px ){ #mb-footer { position: relative; left: auto; transform: none; } #mb-footer span { display: inline-block; } }";d.appendChild(x);x.appendChild(document.createTextNode(r))}});b.doneEach(function(){var n=document.getElementById("mb-footer");if(n&&"No config set"!==c){var f=(new Date).getFullYear(),d=window.location.origin+
-window.location.pathname+"#/";n.innerHTML=("boolean"===typeof m&&m?"":"<hr/>")+"<div style='font-size:70%;'><div>&copy; "+(null==g||g>f?f:g)+(null!=g&&g<f?"&mdash;"+f:"")+"</div>"+(null==t?"<div>":"<a target='_blank' href='"+t+"'>")+y+(""===t?"</div>":"</a>")+"<span>"+("boolean"===typeof l||"string"===typeof l?"boolean"===typeof l?"<a href='"+d+"_policy'>Policy</a>":"<a href='"+d+l+"'>Policy</a>":"")+("boolean"===typeof h||"string"===typeof h?"boolean"===typeof h?"<a href='"+d+"_terms'>Terms</a>":
-"<a href='"+d+h+"'>Terms</a>":"")+("boolean"===typeof u||"string"===typeof u?"boolean"===typeof h?"<a href='"+d+"_cookies'>Cookies</a>":"<a href='"+d+u+"'>Cookies</a>":"")+"</span></div>"}})}window.$docsify.autoFooter=Object.assign(footerOptions,window.$docsify.autoFooter);window.$docsify.plugins=[].concat(autoFooter,window.$docsify.plugins);