Create new base index that redirects

Author: MattIPv4

build/postflight.js

@@ -22,6 +22,20 @@ const fs = require("fs");
 const jsdoc = require("jsdoc-api");
 const ejs = require("ejs");
 
+const templateOptions = {
+    name: "macOSNotifJS",
+    packageName: name,
+    version: version,
+    dateOfBuild: new Date().toISOString().slice(0, 10),
+    description: description,
+    browsers: browserslist.map(x => {
+        return [
+            "https://browserl.ist/?q=" + encodeURIComponent(x),
+            x,
+        ];
+    }),
+};
+
 const buildJSDoc = async position => {
     // Remove previous docs contents
     try {
@@ -44,29 +58,14 @@ const buildJSDoc = async position => {
 };
 
 const injectDocsHome = async position => {
-    // Create the template variables
-    const dateOfBuild = new Date().toISOString().slice(0, 10);
-    const projectName = "macOSNotifJS";
-    const browsers = browserslist.map(x => {
-        return [
-            "https://browserl.ist/?q=" + encodeURIComponent(x),
-            x,
-        ];
-    });
-
     // Render the template
     let html;
     try {
         const templateFile = "build/templates/docs-home.ejs";
         const template = fs.readFileSync(templateFile, "utf8");
         html = ejs.render(template, {
+            ...templateOptions,
             filename: templateFile,
-
-            name: projectName,
-            version: version,
-            dateOfBuild: dateOfBuild,
-            description: description,
-            browsers: browsers,
         });
     } catch (err) {
         console.error(chalk.red.bold(`\n${position} Failed to render custom homepage.`));
@@ -77,7 +76,9 @@ const injectDocsHome = async position => {
     try {
         const filePath = `docs/${name}/${version}/index.html`;
         let file = fs.readFileSync(filePath, "utf8");
-        file = file.replace(`<h3>${name} ${version}</h3>`, html);
+        file = file
+            .replace(`<h3>${name} ${version}</h3>`, html)
+            .replace("<title>", `<title>${name} - v${version} - `);
         fs.writeFileSync(filePath, file);
     } catch (err) {
         console.error(chalk.red.bold(`\n${position} Failed to inject custom homepage.`));
@@ -88,9 +89,29 @@ const injectDocsHome = async position => {
     console.log(chalk.greenBright.bold(`\n${position} Custom JSDoc homepage successfully rendered & injected.`));
 };
 
+const createMainIndex = async position => {
+    // Render the template
+    try {
+        const templateFile = "build/templates/main-index.ejs";
+        const template = fs.readFileSync(templateFile, "utf8");
+        const html = ejs.render(template, {
+            ...templateOptions,
+            filename: templateFile,
+        });
+        fs.writeFileSync("index.html", html);
+    } catch (err) {
+        console.error(chalk.red.bold(`\n${position} Failed to render main index.`));
+        throw err;
+    }
+
+    // Done
+    console.log(chalk.greenBright.bold(`\n${position} Successfully rendered main index file.`));
+};
+
 const processes = [
     buildJSDoc,
     injectDocsHome,
+    createMainIndex,
 ];
 
 const postFlight = async () => {

build/templates/includes/head.ejs

@@ -1,12 +1,12 @@
 <meta charset="UTF-8"/>
 
-<title><%= `${name} - v ${version}` %></title>
+<title><%= `${name} - v${version}` %></title>
 
 <meta name="title"
-      content="<%= `${name} - v ${version}` %>"/>
+      content="<%= `${name} - v${version}` %>"/>
 
 <meta name="description"
-      content="<%= `${name} - v ${version} - ${description}` %>"/>
+      content="<%= `${name} - v${version} - ${description}` %>"/>
 
 <meta name="keywords"
       content="javascript, javascript-plugin, notifications, notification, macos, javascript-tools, javascript-utility, javascript-audio, notification-system, simulated-macos-notifications, macosx, osx, osx-notifications, javascript-library, javascript-framework, notification-service, notification-api"/>
@@ -33,10 +33,10 @@
       content="@MattIPv4"/>
 
 <meta name="twitter:title"
-      content="<%= `${name} - v ${version}` %>"/>
+      content="<%= `${name} - v${version}` %>"/>
 
 <meta name="twitter:description"
-      content="<%= `${name} - v ${version} - ${description}` %>"/>
+      content="<%= `${name} - v${version} - ${description}` %>"/>
 
 <meta name="twitter:image"
       content="https://macosnotif.js.org/brand/macOSNotifJS-818x162.png"/>
@@ -45,7 +45,7 @@
       content="https://macosnotif.js.org/"/>
 
 <meta prefix="og: http://ogp.me/ns#" property="og:title"
-      content="<%= `${name} - v ${version}` %>"/>
+      content="<%= `${name} - v${version}` %>"/>
 
 <meta prefix="og: http://ogp.me/ns#" property="og:type"
       content="website"/>
@@ -57,7 +57,7 @@
       content="<%= name %>"/>
 
 <meta prefix="og: http://ogp.me/ns#" property="og:description"
-      content="<%= `${name} - v ${version} - ${description}` %>"/>
+      content="<%= `${name} - v${version} - ${description}` %>"/>
 
 <meta prefix="og: http://ogp.me/ns#" property="og:url"
       content="https://macosnotif.js.org/"/>

build/templates/main-index.ejs

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<% include includes/head %>
+<% include includes/style %>
+</html>
+<body>
+<% include includes/title %>
+<blockquote class="info">
+    <h2 class="title">
+        <a href="<%= `/docs/${packageName}/${version}/`%>">Redirecting to the latest docs...</a>
+    </h2>
+</blockquote>
+<script>
+    window.location.replace("<%= `/docs/${packageName}/${version}/`%>");
+</script>
+</body>

docs/macosnotif/0.1.1-beta1/Interact.html

@@ -1487,7 +1487,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/Theme.html

@@ -654,7 +654,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Home</title>
+    <title>macosnotif - v0.1.1-beta1 - JSDoc: Home</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -684,7 +684,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/interact.js.html

@@ -229,7 +229,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/macOSNotif.js.html

@@ -710,7 +710,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/macOSNotifJS.html

@@ -858,7 +858,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/macosnotif/0.1.1-beta1/themes.js.html

@@ -152,7 +152,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Interact.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 17:34:59 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Sun Jun 09 2019 19:01:43 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>