pict-docuserve 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Steven Velozo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build-site.js

@@ -0,0 +1,172 @@
+#!/usr/bin/env node
+/**
+ * build-site.js
+ *
+ * Assembles the pict-docuserve dist output together with the retold documentation
+ * content into a single folder suitable for GitHub Pages deployment.
+ *
+ * Usage:
+ *   node build-site.js [--docs-path PATH] [--output-path PATH]
+ *
+ * Defaults:
+ *   --docs-path    ../../../docs     (the retold /docs/ folder)
+ *   --output-path  ./site            (output folder)
+ */
+'use strict';
+
+const libFS = require('fs');
+const libPath = require('path');
+
+// ---------------------------------------------------------------------------
+// Parse arguments
+// ---------------------------------------------------------------------------
+let tmpDocsPath = libPath.resolve(__dirname, '..', '..', '..', 'docs');
+let tmpOutputPath = libPath.resolve(__dirname, 'site');
+let tmpDistPath = libPath.resolve(__dirname, 'dist');
+
+let tmpArgs = process.argv.slice(2);
+for (let i = 0; i < tmpArgs.length; i++)
+{
+	if (tmpArgs[i] === '--docs-path' && tmpArgs[i + 1])
+	{
+		tmpDocsPath = libPath.resolve(tmpArgs[i + 1]);
+		i++;
+	}
+	else if (tmpArgs[i] === '--output-path' && tmpArgs[i + 1])
+	{
+		tmpOutputPath = libPath.resolve(tmpArgs[i + 1]);
+		i++;
+	}
+}
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+/**
+ * Recursively create a directory if it does not exist.
+ */
+function ensureDir(pPath)
+{
+	if (!libFS.existsSync(pPath))
+	{
+		libFS.mkdirSync(pPath, { recursive: true });
+	}
+}
+
+/**
+ * Recursively copy a directory's contents into a destination.
+ */
+function copyDir(pSource, pDest)
+{
+	ensureDir(pDest);
+	let tmpEntries = libFS.readdirSync(pSource, { withFileTypes: true });
+
+	for (let i = 0; i < tmpEntries.length; i++)
+	{
+		let tmpEntry = tmpEntries[i];
+		let tmpSourcePath = libPath.join(pSource, tmpEntry.name);
+		let tmpDestPath = libPath.join(pDest, tmpEntry.name);
+
+		if (tmpEntry.isDirectory())
+		{
+			copyDir(tmpSourcePath, tmpDestPath);
+		}
+		else
+		{
+			libFS.copyFileSync(tmpSourcePath, tmpDestPath);
+		}
+	}
+}
+
+/**
+ * Copy a single file, creating parent directories as needed.
+ */
+function copyFile(pSource, pDest)
+{
+	ensureDir(libPath.dirname(pDest));
+	libFS.copyFileSync(pSource, pDest);
+}
+
+// ---------------------------------------------------------------------------
+// Validate inputs
+// ---------------------------------------------------------------------------
+if (!libFS.existsSync(tmpDistPath))
+{
+	console.error('Error: dist/ folder not found. Run `npm run build` first.');
+	process.exit(1);
+}
+
+if (!libFS.existsSync(tmpDocsPath))
+{
+	console.error('Error: docs folder not found at ' + tmpDocsPath);
+	console.error('Use --docs-path to specify the retold docs/ folder location.');
+	process.exit(1);
+}
+
+// ---------------------------------------------------------------------------
+// Assemble the site
+// ---------------------------------------------------------------------------
+console.log('Assembling site...');
+console.log('  dist:   ' + tmpDistPath);
+console.log('  docs:   ' + tmpDocsPath);
+console.log('  output: ' + tmpOutputPath);
+
+// Clean and create output directory
+if (libFS.existsSync(tmpOutputPath))
+{
+	libFS.rmSync(tmpOutputPath, { recursive: true, force: true });
+}
+ensureDir(tmpOutputPath);
+
+// 1. Copy the entire dist/ folder contents as the base
+console.log('  Copying dist/ build artifacts...');
+copyDir(tmpDistPath, tmpOutputPath);
+
+// 2. Copy markdown content files from docs/
+console.log('  Copying documentation markdown files...');
+let tmpDocsEntries = libFS.readdirSync(tmpDocsPath, { withFileTypes: true });
+let tmpCopiedFiles = [];
+
+for (let i = 0; i < tmpDocsEntries.length; i++)
+{
+	let tmpEntry = tmpDocsEntries[i];
+	let tmpSourcePath = libPath.join(tmpDocsPath, tmpEntry.name);
+	let tmpDestPath = libPath.join(tmpOutputPath, tmpEntry.name);
+
+	// Copy markdown files (including cover.md and _sidebar.md which drive the splash and sidebar views)
+	if (tmpEntry.isFile() && tmpEntry.name.match(/\.md$/))
+	{
+		copyFile(tmpSourcePath, tmpDestPath);
+		tmpCopiedFiles.push(tmpEntry.name);
+	}
+
+	// Copy the catalog JSON
+	if (tmpEntry.isFile() && tmpEntry.name === 'retold-catalog.json')
+	{
+		copyFile(tmpSourcePath, tmpDestPath);
+		tmpCopiedFiles.push(tmpEntry.name);
+	}
+
+	// Copy the keyword index if it exists (for future search support)
+	if (tmpEntry.isFile() && tmpEntry.name === 'retold-keyword-index.json')
+	{
+		copyFile(tmpSourcePath, tmpDestPath);
+		tmpCopiedFiles.push(tmpEntry.name);
+	}
+}
+
+// 3. Create .nojekyll for GitHub Pages
+console.log('  Creating .nojekyll marker...');
+libFS.writeFileSync(libPath.join(tmpOutputPath, '.nojekyll'), '');
+
+// 4. Report
+console.log('');
+console.log('Site assembled successfully!');
+console.log('  Files copied from docs/: ' + tmpCopiedFiles.join(', '));
+console.log('  Output: ' + tmpOutputPath);
+console.log('');
+console.log('To preview locally:');
+console.log('  npx http-server ' + tmpOutputPath);
+console.log('');
+console.log('To deploy to GitHub Pages, push the contents of ' + tmpOutputPath + '/ to your gh-pages branch.');

package/css/docuserve.css

@@ -0,0 +1,73 @@
+/* ============================================================================
+   Pict Docuserve - Base Styles
+   ============================================================================ */
+
+/* Reset and base */
+*, *::before, *::after {
+	box-sizing: border-box;
+}
+
+html, body {
+	margin: 0;
+	padding: 0;
+	font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+	font-size: 16px;
+	line-height: 1.5;
+	color: #333;
+	background-color: #fff;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+}
+
+/* Typography */
+h1, h2, h3, h4, h5, h6 {
+	margin-top: 0;
+	line-height: 1.3;
+}
+
+a {
+	color: #42b983;
+	text-decoration: none;
+}
+
+a:hover {
+	color: #38a373;
+}
+
+/* Application container */
+#Docuserve-Application-Container {
+	min-height: 100vh;
+}
+
+/* Utility: scrollbar styling */
+::-webkit-scrollbar {
+	width: 8px;
+}
+
+::-webkit-scrollbar-track {
+	background: #f1f1f1;
+}
+
+::-webkit-scrollbar-thumb {
+	background: #bdc3c7;
+	border-radius: 4px;
+}
+
+::-webkit-scrollbar-thumb:hover {
+	background: #95a5a6;
+}
+
+/* Responsive adjustments */
+@media (max-width: 768px) {
+	html {
+		font-size: 14px;
+	}
+
+	#Docuserve-Sidebar-Container {
+		display: none;
+	}
+
+	.docuserve-body {
+		flex-direction: column;
+	}
+}

package/dist/css/docuserve.css

@@ -0,0 +1,73 @@
+/* ============================================================================
+   Pict Docuserve - Base Styles
+   ============================================================================ */
+
+/* Reset and base */
+*, *::before, *::after {
+	box-sizing: border-box;
+}
+
+html, body {
+	margin: 0;
+	padding: 0;
+	font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+	font-size: 16px;
+	line-height: 1.5;
+	color: #333;
+	background-color: #fff;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+}
+
+/* Typography */
+h1, h2, h3, h4, h5, h6 {
+	margin-top: 0;
+	line-height: 1.3;
+}
+
+a {
+	color: #42b983;
+	text-decoration: none;
+}
+
+a:hover {
+	color: #38a373;
+}
+
+/* Application container */
+#Docuserve-Application-Container {
+	min-height: 100vh;
+}
+
+/* Utility: scrollbar styling */
+::-webkit-scrollbar {
+	width: 8px;
+}
+
+::-webkit-scrollbar-track {
+	background: #f1f1f1;
+}
+
+::-webkit-scrollbar-thumb {
+	background: #bdc3c7;
+	border-radius: 4px;
+}
+
+::-webkit-scrollbar-thumb:hover {
+	background: #95a5a6;
+}
+
+/* Responsive adjustments */
+@media (max-width: 768px) {
+	html {
+		font-size: 14px;
+	}
+
+	#Docuserve-Sidebar-Container {
+		display: none;
+	}
+
+	.docuserve-body {
+		flex-direction: column;
+	}
+}

package/dist/index.html

@@ -0,0 +1,32 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<meta http-equiv="X-UA-Compatible" content="IE=edge">
+		<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+		<meta name="description" content="Retold Documentation - A suite of JavaScript/Node.js modules for building web applications and APIs">
+
+		<title>Retold Documentation</title>
+
+		<!-- Application Stylesheet -->
+		<link href="css/docuserve.css" rel="stylesheet">
+		<!-- PICT Dynamic View CSS Container -->
+		<style id="PICT-CSS"></style>
+
+		<!-- Load the PICT library -->
+		<script src="./js/pict.min.js" type="text/javascript"></script>
+		<!-- Bootstrap the Application -->
+		<script type="text/javascript">
+//<![CDATA[
+		Pict.safeOnDocumentReady(() => { Pict.safeLoadPictApplication(PictDocuserve, 2)});
+//]]>
+		</script>
+	</head>
+	<body>
+		<!-- The root container for the Pict application -->
+		<div id="Docuserve-Application-Container"></div>
+
+		<!-- Load the Docuserve PICT Application Bundle -->
+		<script src="./pict-docuserve.min.js" type="text/javascript"></script>
+	</body>
+</html>