pict-docuserve 0.0.27 → 0.0.29

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-docuserve",
-    "version": "0.0.27",
+    "version": "0.0.29",
     "description": "Pict Documentation Server - A single-page documentation viewer built on Pict",
     "main": "source/Pict-Application-Docuserve.js",
     "bin": {
@@ -18,25 +18,23 @@
         "build-docs": "npx quack build && npx quack copy && node source/cli/Docuserve-CLI-Run.js inject ./docs && node example_applications/build-examples.js stage-docs",
         "serve-docs": "node source/cli/Docuserve-CLI-Run.js serve ./docs",
         "serve-examples": "node example_applications/build-examples.js",
-        "test": "npx mocha -u tdd --exit -R spec",
-        "tests": "npx mocha -u tdd --exit -R spec --grep",
-        "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec"
+        "test": "npx quack test",
+        "tests": "npx quack test -g",
+        "coverage": "npx quack coverage"
     },
     "author": "steven velozo <steven@velozo.com>",
     "license": "MIT",
     "dependencies": {
         "lunr": "^2.3.9",
-        "pict": "^1.0.348",
-        "pict-application": "^1.0.32",
-        "pict-provider": "^1.0.10",
-        "pict-section-content": "^0.0.5",
-        "pict-service-commandlineutility": "^1.0.18",
-        "pict-view": "^1.0.66"
+        "pict": "^1.0.355",
+        "pict-application": "^1.0.33",
+        "pict-provider": "^1.0.12",
+        "pict-section-content": "^0.0.7",
+        "pict-service-commandlineutility": "^1.0.19",
+        "pict-view": "^1.0.67"
     },
     "devDependencies": {
-        "chai": "^6.2.2",
-        "mocha": "^11.7.5",
-        "quackage": "^1.0.51"
+        "quackage": "^1.0.59"
     },
     "copyFilesSettings": {
         "whenFileExists": "overwrite"

package/source/Pict-Application-Docuserve.js

@@ -61,7 +61,7 @@ class DocuserveApplication extends libPictApplication
 		let tmpDocProvider = this.pict.providers['Docuserve-Documentation'];
 		tmpDocProvider.loadCatalog(() =>
 		{
-			// Set the page title from cover.md or _topbar.md
+			// Set the page title from _cover.md or _topbar.md
 			let tmpDocuserve = this.pict.AppData.Docuserve;
 			if (tmpDocuserve.CoverLoaded && tmpDocuserve.Cover && tmpDocuserve.Cover.Title)
 			{

package/source/providers/Pict-Provider-Docuserve-Documentation.js

@@ -57,10 +57,46 @@ class DocuserveDocumentationProvider extends libPictProvider
 	}
 
 	/**
-	 * Load all documentation data sources: catalog, cover.md, _sidebar.md.
+	 * Create an image resolver closure for the content provider.
+	 *
+	 * Resolves relative image URLs against the directory of the document
+	 * being rendered, so that images referenced with relative paths in
+	 * markdown (e.g. `![graph](diagram.svg)`) resolve correctly even
+	 * when the page uses hash-based routing.
+	 *
+	 * @param {string} pDocURL - The URL the markdown document was fetched from
+	 * @returns {Function} An image resolver callback: (pSrc, pAlt) => resolvedSrc
+	 */
+	_createImageResolver(pDocURL)
+	{
+		// Extract the directory portion of the document URL
+		let tmpBaseDir = '';
+		if (pDocURL)
+		{
+			let tmpLastSlash = pDocURL.lastIndexOf('/');
+			if (tmpLastSlash >= 0)
+			{
+				tmpBaseDir = pDocURL.substring(0, tmpLastSlash + 1);
+			}
+		}
+
+		return (pSrc, pAlt) =>
+		{
+			// Leave absolute URLs, data URIs, and root-relative paths unchanged
+			if (pSrc.match(/^https?:\/\//) || pSrc.match(/^data:/) || pSrc.match(/^\//))
+			{
+				return pSrc;
+			}
+			// Prepend the document's directory to make relative paths work
+			return tmpBaseDir + pSrc;
+		};
+	}
+
+	/**
+	 * Load all documentation data sources: catalog, _cover.md, _sidebar.md.
 	 *
 	 * Loads the catalog first (it provides the fallback data), then attempts
-	 * to load cover.md and _sidebar.md in parallel.  If those markdown files
+	 * to load _cover.md and _sidebar.md in parallel.  If those markdown files
 	 * exist they drive the splash and sidebar views; otherwise the catalog
 	 * data is used as a fallback.
 	 *
@@ -74,7 +110,7 @@ class DocuserveDocumentationProvider extends libPictProvider
 
 		let tmpLoadOptionalFiles = () =>
 		{
-			// Load cover.md, _sidebar.md, _topbar.md, errorpage.md and keyword index in parallel.
+			// Load _cover.md, _sidebar.md, _topbar.md, errorpage.md and keyword index in parallel.
 			// When all are done, if we still have no sidebar data, try to auto-discover
 			// a README.md so the site works with plain markdown folders.
 			let tmpPending = 5;
@@ -205,9 +241,9 @@ class DocuserveDocumentationProvider extends libPictProvider
 	}
 
 	/**
-	 * Fetch and parse cover.md into structured data for the splash view.
+	 * Fetch and parse _cover.md into structured data for the splash view.
 	 *
-	 * The expected cover.md format follows the docsify convention:
+	 * The expected _cover.md format follows the docsify convention:
 	 *   # Title
 	 *   > Tagline
 	 *   Description paragraph text.
@@ -224,7 +260,7 @@ class DocuserveDocumentationProvider extends libPictProvider
 		let tmpCallback = (typeof(fCallback) === 'function') ? fCallback : () => {};
 		let tmpDocsBase = this.pict.AppData.Docuserve.DocsBaseURL || '';
 
-		fetch(tmpDocsBase + 'cover.md')
+		fetch(tmpDocsBase + '_cover.md')
 			.then((pResponse) =>
 			{
 				if (!pResponse.ok)
@@ -237,7 +273,7 @@ class DocuserveDocumentationProvider extends libPictProvider
 			{
 				if (!pMarkdown)
 				{
-					this.log.info('Docuserve: No cover.md found; splash will use catalog data.');
+					this.log.info('Docuserve: No _cover.md found; splash will use catalog data.');
 					return tmpCallback();
 				}
 
@@ -247,15 +283,15 @@ class DocuserveDocumentationProvider extends libPictProvider
 			})
 			.catch((pError) =>
 			{
-				this.log.warn(`Docuserve: Error loading cover.md: ${pError}`);
+				this.log.warn(`Docuserve: Error loading _cover.md: ${pError}`);
 				return tmpCallback();
 			});
 	}
 
 	/**
-	 * Parse cover.md markdown text into a structured object.
+	 * Parse _cover.md markdown text into a structured object.
 	 *
-	 * @param {string} pMarkdown - Raw cover.md content
+	 * @param {string} pMarkdown - Raw _cover.md content
 	 * @returns {Object} Parsed cover data
 	 */
 	parseCover(pMarkdown)
@@ -1286,7 +1322,7 @@ class DocuserveDocumentationProvider extends libPictProvider
 					return tmpCallback('Document not found', this.getErrorPageHTML(pURL));
 				}
 
-				let tmpHTML = this._ContentProvider.parseMarkdown(pMarkdown, this._createLinkResolver(pCurrentGroup, pCurrentModule, pCurrentDocPath));
+				let tmpHTML = this._ContentProvider.parseMarkdown(pMarkdown, this._createLinkResolver(pCurrentGroup, pCurrentModule, pCurrentDocPath), this._createImageResolver(pURL));
 				this._ContentCache[pURL] = tmpHTML;
 				return tmpCallback(null, tmpHTML);
 			})

package/source/views/PictView-Docuserve-Splash.js

@@ -162,7 +162,7 @@ class DocusserveSplashView extends libPictView
 	}
 
 	/**
-	 * Render the splash screen from parsed cover.md data.
+	 * Render the splash screen from parsed _cover.md data.
 	 *
 	 * @param {Object} pCover - The parsed cover data { Title, Tagline, Description, Highlights, Actions }
 	 */
@@ -212,7 +212,7 @@ class DocusserveSplashView extends libPictView
 	}
 
 	/**
-	 * Render the splash screen from catalog data as a fallback when cover.md
+	 * Render the splash screen from catalog data as a fallback when _cover.md
 	 * is not available.
 	 *
 	 * @param {Object} pDocuserve - The AppData.Docuserve state