Added a custom documentation title: Create a post-processing script to replace JSDoc default title with 'Notes API Documentation'

Author: starichkov

jsdoc.config.json

@@ -7,7 +7,8 @@
   "opts": {
     "destination": "./docs/",
     "recurse": true,
-    "readme": "./README.md"
+    "readme": "./README.md",
+    "title": "Notes API Documentation"
   },
   "plugins": ["plugins/markdown"],
   "templates": {

package.json

@@ -11,7 +11,7 @@
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
     "start": "node src/notes-api-server.js",
-    "docs": "jsdoc -c jsdoc.config.json",
+    "docs": "jsdoc -c jsdoc.config.json && node scripts/fix-docs-title.js",
     "docs:watch": "jsdoc -c jsdoc.config.json --watch",
     "docs:version": "node scripts/version-docs.js",
     "docs:serve": "cd docs && python3 -m http.server 8080",

scripts/fix-docs-title.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+/**
+ * Post-processing script to fix JSDoc HTML titles
+ * Updates "JSDoc: Home" to a more meaningful title
+ */
+
+import fs from 'fs';
+import path from 'path';
+
+const DOCS_DIR = 'docs';
+const OLD_TITLE = 'JSDoc: Home';
+const NEW_TITLE = 'Notes API Documentation';
+
+/**
+ * Recursively find and update HTML files in the docs directory
+ */
+function updateHTMLTitles(dir) {
+    const files = fs.readdirSync(dir);
+    
+    for (const file of files) {
+        const filePath = path.join(dir, file);
+        const stat = fs.statSync(filePath);
+        
+        if (stat.isDirectory()) {
+            updateHTMLTitles(filePath);
+        } else if (file.endsWith('.html')) {
+            updateHTMLFile(filePath);
+        }
+    }
+}
+
+/**
+ * Update title in a single HTML file
+ */
+function updateHTMLFile(filePath) {
+    const content = fs.readFileSync(filePath, 'utf8');
+    
+    // Replace the title tag
+    const updatedContent = content.replace(
+        `<title>${OLD_TITLE}</title>`,
+        `<title>${NEW_TITLE}</title>`
+    );
+    
+    // Also update page title heading if it's the home page
+    const finalContent = updatedContent.replace(
+        '<h1 class="page-title">Home</h1>',
+        '<h1 class="page-title">Notes API Documentation</h1>'
+    );
+    
+    if (content !== finalContent) {
+        fs.writeFileSync(filePath, finalContent);
+        console.log(`✅ Updated title in ${filePath}`);
+    }
+}
+
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    console.log('🔧 Fixing documentation titles...');
+    
+    if (!fs.existsSync(DOCS_DIR)) {
+        console.error(`❌ Documentation directory '${DOCS_DIR}' not found`);
+        process.exit(1);
+    }
+    
+    updateHTMLTitles(DOCS_DIR);
+    console.log('✅ Documentation titles updated successfully');
+}