@kenjura/ursa 0.35.0 → 0.40.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# 0.40.0
+2025-12-13
+
+- Added footer
+
+# 0.39.0
+2025-12-13
+
+- Updated to node 24.5 to satisfy npm Trusted Publishing
+- Refactored Github Actions
+- Added CONTRIBUTING.md
+
+# 0.38.0
+2025-12-13
+
+- Updated Github Actions workflow to use OIDC for authentication
+
+# 0.37.0
+2025-12-13
+
+- Added Github Actions workflow for CI/CD (npm publish)
+
+# 0.36.0
+2025-12-13
+
+- Links to a valid .md file in source will now render as a link to the corresponding .html file (and show as an active link)
+
 # 0.35.0
 2025-12-11
 

package/meta/default-template.html

@@ -33,6 +33,9 @@
     <article id="main-content">
         ${body}
     </article>
+    <footer id="site-footer">
+        ${footer}
+    </footer>
     <div id="global-nav">
     </div>
 

package/meta/default.css

@@ -432,6 +432,43 @@ article#main-content {
   }
 }
 
+/* Footer styles */
+footer#site-footer {
+  width: var(--article-width);
+  margin: 3rem auto 2rem auto;
+  padding-top: 2rem;
+  border-top: 1px solid rgba(128, 128, 128, 0.3);
+  text-align: center;
+  
+  .footer-content {
+    margin-bottom: 1.5rem;
+    font-size: 0.95rem;
+    opacity: 0.85;
+  }
+  
+  .footer-meta {
+    font-size: 0.8rem;
+    opacity: 0.6;
+    margin-bottom: 0.5rem;
+    
+    a {
+      color: inherit;
+    }
+  }
+  
+  .footer-copyright {
+    font-size: 0.8rem;
+    opacity: 0.6;
+  }
+}
+
+@media (max-width: 800px) {
+  footer#site-footer {
+    width: calc(100vw - 2rem);
+    margin: 3rem 1rem 2rem 1rem;
+  }
+}
+
 @media (max-width: 800px) {
   nav#nav-global {
     display: flex;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@kenjura/ursa",
   "author": "Andrew London <andrew@kenjura.com>",
   "type": "module",
-  "version": "0.35.0",
+  "version": "0.40.0",
   "description": "static site generator from MD/wikitext/YML",
   "main": "lib/index.js",
   "bin": {

package/src/helper/automenu.js

@@ -129,7 +129,7 @@ function buildMenuData(tree, source, validPaths, parentPath = '') {
   const items = [];
   
   // Files to hide from menu by default
-  const hiddenFiles = ['config.json', 'style.css'];
+  const hiddenFiles = ['config.json', 'style.css', 'footer.md'];
   
   for (const item of tree.children || []) {
     const ext = extname(item.path);

package/src/helper/linkValidator.js

@@ -157,7 +157,24 @@ function resolveHref(href, validPaths, currentDocPath = null) {
   // Check if the href already has an extension
   const ext = extname(hrefWithoutHash);
   if (ext) {
-    // Has extension but doesn't exist
+    // Special handling for .md links - convert to .html if valid
+    if (ext.toLowerCase() === '.md') {
+      // Remove .md and check if .html version exists
+      const pathWithoutMd = normalized.slice(0, -3); // Remove '.md'
+      const htmlPath = pathWithoutMd + '.html';
+      debugTries.push(`${normalized} (.md → .html) ${htmlPath} → ${validPaths.has(htmlPath) ? '✓' : '✗'}`);
+      if (validPaths.has(htmlPath)) {
+        // Convert .md to .html in the resolved href
+        const resolvedHref = absoluteHref.slice(0, -3) + '.html' + hash;
+        return { resolvedHref, inactive: false, debug: debugTries.join(' | ') };
+      }
+      // Also check without extension (in case valid paths don't have .html suffix)
+      if (validPaths.has(pathWithoutMd)) {
+        const resolvedHref = absoluteHref.slice(0, -3) + '.html' + hash;
+        return { resolvedHref, inactive: false, debug: debugTries.join(' | ') };
+      }
+    }
+    // Has extension but doesn't exist (or is not .md)
     debugTries.push(`${normalized} → ✗`);
     return { resolvedHref: absoluteHref + hash, inactive: true, debug: debugTries.join(' | ') };
   }

package/src/jobs/generate.js

@@ -128,6 +128,9 @@ export async function generate({
 
   const menu = await getMenu(allSourceFilenames, source, validPaths);
 
+  // Generate footer content
+  const footer = await getFooter(source, _source);
+
   // Load content hash cache from .ursa folder in source directory
   let hashCache = new Map();
   if (!_clean) {
@@ -285,7 +288,8 @@ export async function generate({
           .replace("${transformedMetadata}", transformedMetadata)
           .replace("${body}", body)
           .replace("${embeddedStyle}", embeddedStyle)
-          .replace("${searchIndex}", JSON.stringify(searchIndex));
+          .replace("${searchIndex}", JSON.stringify(searchIndex))
+          .replace("${footer}", footer);
 
         // Resolve links and mark broken internal links as inactive (debug mode on)
         // Pass docUrlPath so relative links can be resolved correctly
@@ -378,7 +382,8 @@ export async function generate({
             .replace("${title}", "Index")
             .replace("${meta}", "{}")
             .replace("${transformedMetadata}", "")
-            .replace("${embeddedStyle}", "");
+            .replace("${embeddedStyle}", "")
+            .replace("${footer}", footer);
           console.log(`writing directory index to ${htmlOutputFilename}`);
           await outputFile(htmlOutputFilename, finalHtml);
         }
@@ -541,3 +546,70 @@ function addTrailingSlash(somePath) {
   if (somePath[somePath.length - 1] == "/") return somePath;
   return `${somePath}/`;
 }
+
+/**
+ * Generate footer HTML from footer.md and package.json
+ * @param {string} source - resolved source path with trailing slash
+ * @param {string} _source - original source path
+ */
+async function getFooter(source, _source) {
+  const footerParts = [];
+  
+  // Try to read footer.md from source root
+  const footerPath = join(source, 'footer.md');
+  try {
+    if (existsSync(footerPath)) {
+      const footerMd = await readFile(footerPath, 'utf8');
+      const footerHtml = renderFile({ fileContents: footerMd, type: '.md' });
+      footerParts.push(`<div class="footer-content">${footerHtml}</div>`);
+    }
+  } catch (e) {
+    console.error(`Error reading footer.md: ${e.message}`);
+  }
+  
+  // Try to read package.json from doc repo
+  let docPackage = null;
+  const packagePath = join(resolve(_source), 'package.json');
+  try {
+    if (existsSync(packagePath)) {
+      const packageJson = await readFile(packagePath, 'utf8');
+      docPackage = JSON.parse(packageJson);
+    }
+  } catch (e) {
+    console.error(`Error reading doc package.json: ${e.message}`);
+  }
+  
+  // Get ursa version from ursa's own package.json
+  let ursaVersion = 'unknown';
+  try {
+    const ursaPackagePath = new URL('../../../package.json', import.meta.url).pathname;
+    const ursaPackageJson = await readFile(ursaPackagePath, 'utf8');
+    const ursaPackage = JSON.parse(ursaPackageJson);
+    ursaVersion = ursaPackage.version;
+  } catch (e) {
+    console.error(`Error reading ursa package.json: ${e.message}`);
+  }
+  
+  // Build meta line: version, timestamp, "generated by ursa"
+  const metaParts = [];
+  if (docPackage?.version) {
+    metaParts.push(`v${docPackage.version}`);
+  }
+  metaParts.push(new Date().toISOString().split('T')[0]); // YYYY-MM-DD
+  metaParts.push(`Generated by <a href="https://www.npmjs.com/package/@kenjura/ursa">ursa</a> v${ursaVersion}`);
+  
+  footerParts.push(`<div class="footer-meta">${metaParts.join(' • ')}</div>`);
+  
+  // Copyright line from doc package.json
+  if (docPackage?.copyright) {
+    footerParts.push(`<div class="footer-copyright">${docPackage.copyright}</div>`);
+  } else if (docPackage?.author) {
+    const year = new Date().getFullYear();
+    const author = typeof docPackage.author === 'string' ? docPackage.author : docPackage.author.name;
+    if (author) {
+      footerParts.push(`<div class="footer-copyright">© ${year} ${author}</div>`);
+    }
+  }
+  
+  return footerParts.join('\n');
+}