astro-accelerator 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,6 @@
+# Astro Accelerator
+
+Review the documentation at [astro.stevefenton.co.uk](https://astro.stevefenton.co.uk/)
+
+[![Deploy and Test](https://github.com/Steve-Fenton/astro-accelerator/actions/workflows/build-astro.yml/badge.svg)](https://github.com/Steve-Fenton/astro-accelerator/actions/workflows/build-astro.yml)
+

package/package.json

@@ -0,0 +1,52 @@
+{
+  "version": "0.0.1",
+  "author": "Steve Fenton",
+  "name": "astro-accelerator",
+  "description": "A super-lightweight, accessible, SEO-friendly starter project for Astro",
+  "keywords": [
+    "astro",
+    "themes"
+  ],
+  "type": "module",
+  "homepage": "https://astro.stevefenton.co.uk/",
+  "bugs": "https://github.com/Steve-Fenton/astro-accelerator/issues",
+  "license": "(Apache-2.0)",
+  "files": [
+    "src/pages/authors/[author]/[page].astro",
+    "src/pages/articles/[page].astro",
+    "src/pages/articles/feed.xml.ts",
+    "src/pages/category/[category]/[page].astro",
+    "src/pages/tag/[tag]/[page].astro",
+    "src/pages/search.json.ts",
+    "src/pages/sitemap.xml.ts",
+    "src/pages/report/*",
+    "src/layouts/*",
+    "src/themes/**/*",
+    "src/data/*",
+    "public/js/**/*"
+  ],
+  "repository": {
+    "url": "https://github.com/Steve-Fenton/astro-accelerator"
+  },
+  "scripts": {
+    "img": "node --no-experimental-fetch ./src/themes/accelerator/utilities/img.mjs",
+    "dev": "node --no-experimental-fetch ./src/themes/accelerator/utilities/img.mjs && astro dev",
+    "test": "astro build && npx playwright test",
+    "build": "astro build",
+    "preview": "astro preview",
+    "astro": "astro",
+    "dts": "tsc ./tests/locate-content.js ./tests/locate-navigation.js ./tests/locate-search.js --allowJs --declaration --emitDeclarationOnly"
+  },
+  "dependencies": {
+    "@squoosh/lib": "^0.4.0",
+    "astro": "^1.6.7",
+    "hast-util-from-selector": "^2.0.0",
+    "remark-directive": "^2.0.1"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.27.1"
+  },
+  "engines": {
+    "node": "*"
+  }
+}

package/public/js/main.js

@@ -0,0 +1,45 @@
+// @ts-check
+import { addIntersectionObserver, addListImageIntersectionObserver } from './modules/animation.js';
+import { addResizedEvent } from './modules/resizing.js';
+import { addStickyNavigation } from './modules/nav-sticky.js';
+import { addMobileNavigation } from './modules/nav-mobile.js';
+import { setClickableBlocks } from './modules/click-blocks.js';
+import { setExternalLinkAttributes } from './modules/external-links.js';
+
+const resizedEventName = addResizedEvent();
+
+setClickableBlocks();
+setExternalLinkAttributes();
+addStickyNavigation('.site-header', '#site-nav', '#site-nav > ul', resizedEventName);
+addMobileNavigation('.navigation-icon', '#site-nav', resizedEventName);
+addIntersectionObserver('.anim-show-parent img, .anim-show-parent > *:not(h1, h2, h3, h4, h5, h6)');
+addListImageIntersectionObserver('.post-list img');
+
+// @ts-ignore
+const f = site_features ?? {};
+
+/**
+ * 
+ * @param {string[]} settings 
+ * @param {string} option 
+ * @returns 
+ */
+function enabled(settings, option) {
+    return settings
+        && settings.includes(option);
+}
+
+if (enabled(f.youTubeLinks, 'embed')) {
+    const youTube = await import('./modules/youtube.js');
+    youTube.enhanceYoutubeLinks();
+}
+
+if (enabled(f.codeBlocks, 'copy')) {
+    const codeBlocks = await import('./modules/code-blocks.js');
+    codeBlocks.enhanceCodeBlocks();
+}
+
+if (enabled(f.figures, 'enlarge')) {
+    const figures = await import('./modules/figures.js');
+    figures.enhanceFigures();
+}

package/public/js/modules/animation.js

@@ -0,0 +1,69 @@
+// @ts-check
+
+import { qsa } from './query.js';
+
+/**
+ * Assists animation by setting "--shown" CSS property
+ * 
+ * When an item is visible in the viewport, it will have --shown: 1
+ * Otherwise it will be --shown: 0
+ * This allows CSS transitions and calculated properties to animate elements
+ * 
+ * Example
+ *     transition: all 0.2s ease-in;
+ *     scale: calc(0.75 + (var(--shown, 1) * 0.25));
+ * 
+ * @param {string} listItemQuery 
+ */
+function addIntersectionObserver(listItemQuery) {
+    function handleIntersection(entries, observer) {
+        for (let entry of entries) {
+            const value = entry.isIntersecting ? 1 : 0;
+            entry.target.style.setProperty('--shown', value);
+        }
+    }
+
+    const options = {
+        root: null,
+        rootMargin: '0px',
+        threshold: 0
+    };
+
+    const observer = new IntersectionObserver(handleIntersection, options)
+
+    qsa(listItemQuery).forEach((elem) => observer.observe(elem));
+}
+
+/**
+ * Assists animation by setting "--shown" CSS property
+ * 
+ * When an item is visible in the viewport, it will have --shown: 1
+ * Otherwise it will be --shown: 0
+ * This allows CSS transitions and calculated properties to animate elements
+ * 
+ * Example
+ *     transition: all 0.2s ease-in;
+ *     scale: calc(0.75 + (var(--shown, 1) * 0.25));
+ * 
+ * @param {string} imgItemQuery 
+ */
+ function addListImageIntersectionObserver(imgItemQuery) {
+    function handleIntersection(entries, observer) {
+        for (let entry of entries) {
+            const value = entry.isIntersecting ? 1 : 0;
+            entry.target.style.setProperty('--imgshown', value);
+        }
+    }
+
+    const options = {
+        root: null,
+        rootMargin: '0px',
+        threshold: 0.5
+    };
+
+    const observer = new IntersectionObserver(handleIntersection, options)
+
+    qsa(imgItemQuery).forEach((elem) => observer.observe(elem));
+}
+
+export { addIntersectionObserver, addListImageIntersectionObserver };

package/public/js/modules/click-blocks.js

@@ -0,0 +1,41 @@
+// @ts-check
+
+import { qsa } from './query.js';
+
+const dataAttributeName = 'data-destination';
+
+/**
+ * Makes an entire block clickable based on a data-attribute, usually "data-destination"
+ * 
+ * Example: You have a list of blog posts, including featured images. If you make the title
+ * clickable, clicks on the image won't open the blog. Adding links to the images means
+ * keyboard users have to tab twice as much to get through the list.
+ * 
+ * Use clickable blocks to allow keyboard users to tab through the real links, but still
+ * capture clicks elsewhere on the block.
+ * 
+ */
+ function setClickableBlocks() {
+    qsa('[' + dataAttributeName + ']').forEach((listItem) => {
+        listItem.style.cursor = 'pointer';
+        listItem.addEventListener('click', handleClick);
+    });
+}
+
+/**
+ * Handles the block-level clicks
+ * 
+ * @param {Event} e 
+ * @returns 
+ */
+function handleClick(e) {
+    const location = this.getAttribute(dataAttributeName);
+
+    if (location) {
+        e.preventDefault();
+        document.location = location;
+        return false;
+    }
+}
+
+export { setClickableBlocks };

package/public/js/modules/code-blocks.js

@@ -0,0 +1,59 @@
+import { qs, qsa } from './query.js';
+
+const activeClass = "copy-button";
+
+const clipboard = `<svg xmlns="http://www.w3.org/2000/svg" title="Copy" width="30" height="30" viewBox="0 0 24 24" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
+<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+<path d="M9 5h-2a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h10a2 2 0 0 0 2 -2v-12a2 2 0 0 0 -2 -2h-2" />
+<rect x="9" y="3" width="6" height="4" rx="2" />
+</svg>`;
+
+const clipboardDone = `<svg xmlns="http://www.w3.org/2000/svg" title="Copied" width="30" height="30" viewBox="0 0 24 24" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
+<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+<path d="M9 5h-2a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h10a2 2 0 0 0 2 -2v-12a2 2 0 0 0 -2 -2h-2" />
+<rect x="9" y="3" width="6" height="4" rx="2" />
+<path d="M9 14l2 2l4 -4" />
+</svg>`;
+
+const clipboardError = `<svg xmlns="http://www.w3.org/2000/svg" title="Cannot copy" width="30" height="30" viewBox="0 0 24 24" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
+<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+<path d="M9 5h-2a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h10a2 2 0 0 0 2 -2v-12a2 2 0 0 0 -2 -2h-2" />
+<rect x="9" y="3" width="6" height="4" rx="2" />
+<path d="M10 12l4 4m0 -4l-4 4" />
+</svg>`
+
+/** 
+ * Enables copy on code blocks (<pre><code>...)
+*/
+function enhanceCodeBlocks() {
+
+    // Make code blocks focusable, so they can be keyboard scrolled
+    qsa('pre.astro-code').forEach((elem) => elem.setAttribute('tabindex', '0'));
+
+    qsa(`pre:not(.${activeClass})`).forEach(node => {
+        const copy = document.createElement('button');
+        copy.classList.add(activeClass);
+        copy.innerHTML = clipboard;
+        copy.title = 'Copy';
+
+        const copyContainer = document.createElement('div');
+        copyContainer.className = 'copy-container';
+        copyContainer.appendChild(copy);
+
+        node.insertAdjacentElement('beforebegin', copyContainer);
+        copy.addEventListener('click', async () => {
+            if (navigator.clipboard) {
+                // @ts-ignore
+                const text = qs('code', node).innerText;
+                await navigator.clipboard.writeText(text);
+                copy.innerHTML = clipboardDone;
+            } else {
+                copy.innerHTML = clipboardError;
+            }
+
+            setTimeout(() => copy.innerHTML = clipboard, 2000);
+        });
+    });
+}
+
+export { enhanceCodeBlocks }

package/public/js/modules/events.js

@@ -0,0 +1,19 @@
+// @ts-check
+
+/**
+ * 
+ * @param {string} name 
+ * @param {{[key: string]: any}} detail 
+ * @param {Document | HTMLElement} [target]
+ */
+function raiseEvent(name, detail, target) {
+    if (!target) {
+        target = document;
+    }
+
+    const event = new CustomEvent(name, { detail: detail});
+    document.dispatchEvent(event);
+    console.log('Event Raised', name, detail);
+}
+
+export { raiseEvent };

package/public/js/modules/external-links.js

@@ -0,0 +1,20 @@
+import { qsa } from './query.js';
+
+function setExternalLinkAttributes() {
+    // Open external links in a new tab
+    qsa('a[href^=http]').forEach((link) => {
+        // Open external links in a new tab
+        const destination = new URL(link.href);
+        if (destination.hostname != window.location.hostname) {
+            if (!link.target) {
+                link.setAttribute('target', '_blank');
+            }
+
+            if (!link.rel) {
+                link.setAttribute('rel', 'noopener');
+            }
+        }
+    });
+}
+
+export { setExternalLinkAttributes }

package/public/js/modules/figures.js

@@ -0,0 +1,37 @@
+import { qs, qsa } from './query.js';
+
+const activeClass = 'magnify-icon';
+
+const clipboard = `<svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 24 24" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
+  <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+  <line x1="15" y1="8" x2="15.01" y2="8" />
+  <rect x="4" y="4" width="16" height="16" rx="3" />
+  <path d="M4 15l4 -4a3 5 0 0 1 3 0l5 5" />
+  <path d="M14 14l1 -1a3 5 0 0 1 3 0l2 2" />
+</svg>`;
+
+/** 
+ * Enables copy on code blocks (<pre><code>...)
+*/
+function enhanceFigures() {
+    qsa(`figure > p > img`).forEach(node => {
+        const src = node.src;
+
+        const magnify = document.createElement('button');
+        magnify.classList.add(activeClass);
+        magnify.innerHTML = clipboard;
+        magnify.title = 'Enlarge';
+
+        const magnifyContainer = document.createElement('div');
+        magnifyContainer.className = 'magnify-container';
+        magnifyContainer.appendChild(magnify);
+
+        node.insertAdjacentElement('beforebegin', magnifyContainer);
+
+        magnify.addEventListener('click', async () => {
+            window.open(src);
+        });
+    });
+}
+
+export { enhanceFigures }

package/public/js/modules/focus.js

@@ -0,0 +1,76 @@
+// @ts-check
+
+import { qsa } from './query.js';
+
+/**
+ * Gets first, last, and all focusable elements in the target
+ * 
+ * For the supplied element, finds all the elements that can receive keyboard focus.
+ * 
+ * Examples: a, button, input, textarea, select, and other valid interactive items
+ * that haven't been disabled or hidden.
+ * 
+ * @param {HTMLElement} target element
+ * @returns {{first: HTMLElement, last: HTMLElement, all: HTMLElement[]}}
+ */
+ function getFocusableElement(target) {
+    const focusElements = Array.from(
+        qsa('a[href], button, input, textarea, select, details,[tabindex]:not([tabindex="-1"])', target)
+    ).filter(function(el) {
+        return !el.hasAttribute('disabled') && !el.getAttribute('aria-hidden');
+    });
+    
+    return {
+        first: focusElements[0],
+        last: focusElements[focusElements.length -1],
+        all: focusElements
+    };
+}
+
+/**
+ * Mechanism to trap focus
+ * 
+ * @param {KeyboardEvent} event 
+ * @param {HTMLElement} focusItem 
+ * @returns 
+ */
+function trapFocus(event, focusItem) {
+    switch (event.code.toLowerCase()) {
+        case 'tab':
+        event.preventDefault();    
+        focusItem.focus();
+        return false;
+    }
+}
+
+/**
+ * Mechanism to trap focus (TAB)
+ * 
+ * @param {KeyboardEvent} event 
+ * @param {HTMLElement} focusItem 
+ * @returns 
+ */
+function trapFocusForward(event, focusItem) {
+    if (event.shiftKey) {
+        return;
+    }
+
+    trapFocus(event, focusItem);
+}
+
+/**
+ * Mechanism to trap tab (SHIFT + TAB)
+ * 
+ * @param {KeyboardEvent} event 
+ * @param {HTMLElement} focusItem 
+ * @returns 
+ */
+function trapReverseFocus(event, focusItem) {
+    if (!event.shiftKey) {
+        return;
+    }
+
+    trapFocus(event, focusItem);
+}
+
+export { getFocusableElement, trapFocusForward, trapReverseFocus };