Initial commit

4 files changed, 102 insertions, 0 deletions

diff --git a/ExplainXKCD-Quick-Link/LICENSE.txt b/ExplainXKCD-Quick-Link/LICENSE.txt
new file mode 100644
index 0000000..0db771a
--- /dev/null
+++ b/ExplainXKCD-Quick-Link/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Arjun Satarkar
+
+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.
diff --git a/ExplainXKCD-Quick-Link/README.md b/ExplainXKCD-Quick-Link/README.md
new file mode 100644
index 0000000..943cc00
--- /dev/null
+++ b/ExplainXKCD-Quick-Link/README.md
@@ -0,0 +1,21 @@
+# ExplainXKCD-Quick-Link
+
+A userscript for [xkcd](https://xkcd.com/), "a webcomic of romance, sarcasm, math, and language", which for each comic adds a link to the comic's [explain xkcd](https://www.explainxkcd.com/wiki/index.php/Main_Page) page.
+
+Here is a screenshot of the addition:
+
+<img src="https://github.com/untir-l/userscripts/blob/main/Explain-XKCD-Quick-Link/screenshot.png?raw=true" width="500">
+
+This will always go to the page for the specific comic you are viewing.
+
+## Usage
+
+Load `explainxkcd_quick_link.user.js` into your userscript manager of choice (it is tested with Tampermonkey).
+
+A userscript is a bit like a browser extension - it's a JavaScript file which is automatically executed on certain pages (in this case on xkcd) and improves them in some way. You will need an extension like Tampermonkey or Greasemonkey to use userscripts.
+
+## Copyright and technical info
+
+This userscript is copyright © 2021 Arjun Satarkar and licensed under the MIT License. See LICENSE.txt for the full text.
+
+Written in JavaScript to run as a TamperMonkey userscript. Code formatted using the XO style with ESLint.
diff --git a/ExplainXKCD-Quick-Link/explainxkcd_quick_link.user.js b/ExplainXKCD-Quick-Link/explainxkcd_quick_link.user.js
new file mode 100644
index 0000000..3fc75ac
--- /dev/null
+++ b/ExplainXKCD-Quick-Link/explainxkcd_quick_link.user.js
@@ -0,0 +1,60 @@
+// ==UserScript==
+// @name         ExplainXKCD-Quick-Link
+// @namespace    https://github.com/untir-l/userscripts
+// @version      1.0.2
+// @description  For each comic on xkcd.com, add a link to the comic's ExplainXKCD page.
+// @author       Arjun Satarkar
+// @match        https://xkcd.com/*
+// @icon         https://www.explainxkcd.com/wiki/images/c/c9/Logo.png
+// @grant        none
+// ==/UserScript==
+/*
+MIT License
+
+Copyright (c) 2021 Arjun Satarkar
+
+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.
+ */
+
+(function () {
+	'use strict';
+	const explainXkcdLogoHeight = '10ex'; // Height in CSS size units
+
+	const middleContainer = document.querySelector('div#middleContainer');
+
+	let comicNum;
+	try {
+		comicNum = /\d+/.exec(/Permanent link to this comic: https:\/\/xkcd\.com\/\d+\//.exec(middleContainer.innerText)[0])[0];
+	} catch (_) {
+		return; // We must not be on a comic page, so skip the rest of the script.
+	}
+
+	const explanationLinkElement = document.createElement('a');
+	explanationLinkElement.setAttribute('href', `https://explainxkcd.com/${comicNum}`);
+
+	const explainXkcdLogoElement = document.createElement('img');
+	explainXkcdLogoElement.setAttribute('src', 'https://www.explainxkcd.com/wiki/images/c/c9/Logo.png');
+	explainXkcdLogoElement.setAttribute('style', `height: ${explainXkcdLogoHeight};`);
+	explainXkcdLogoElement.setAttribute('alt', 'Explain xkcd');
+	explanationLinkElement.appendChild(explainXkcdLogoElement);
+
+	const addedContent = new DocumentFragment();
+	addedContent.append(document.createElement('br'), explanationLinkElement);
+	middleContainer.appendChild(addedContent);
+})();
diff --git a/ExplainXKCD-Quick-Link/screenshot.png b/ExplainXKCD-Quick-Link/screenshot.png
new file mode 100644
index 0000000..5febb34
--- /dev/null
+++ b/ExplainXKCD-Quick-Link/screenshot.png