hdoc-tools 0.60.1 → 0.62.0

package/hdoc-ver.js

@@ -12,7 +12,9 @@
 		);
 		let hdocbook_project;
 		try {
-			hdocbook_project = require(hdocbook_project_config_path);
+			hdocbook_project = JSON.parse(
+				fs.readFileSync(hdocbook_project_config_path, "utf8"),
+			);
 		} catch (e) {
 			console.error("File not found: hdocbook-project.json:");
 			console.log(e, "\n");
@@ -26,7 +28,7 @@
 
 		let hdocbook_config;
 		try {
-			hdocbook_config = require(hdocbook_path);
+			hdocbook_config = JSON.parse(fs.readFileSync(hdocbook_path, "utf8"));
 		} catch (e) {
 			console.error("File not found: hdocbook.json");
 			console.log(e, "\n");

package/hdoc.js

@@ -162,7 +162,6 @@
 	let gen_exclude = false;
 	let bump_type = "patch"; // To generate spellcheck exclusions for all files
 	let output_links = true;
-	let onyx_index = false;
 	let build_embeddings = true;
 
 	// Get options from command args
@@ -211,8 +210,6 @@
 			console_color = false;
 		} else if (process.argv[x].toLowerCase() === "--no-links") {
 			output_links = false;
-		} else if (process.argv[x].toLowerCase() === "--onyx") {
-			onyx_index = true;
 		} else if (process.argv[x].toLowerCase() === "--no-embeddings") {
 			build_embeddings = false;
 		} else if (process.argv[x].toLowerCase() === "--quiet") {
@@ -247,15 +244,19 @@
 	}
 
 
-	// Add validated-links.txt to .gitignore if it doesn't exist
-	const gitignorePath = path.join(source_path, ".gitignore");
-	if (fs.existsSync(gitignorePath)) {
-		const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
-		if (!gitignoreContent.includes("validated-links.txt")) {
-			fs.appendFileSync(gitignorePath, "\nvalidated-links.txt\n");
-			console.info("Added validated-links.txt to .gitignore");
+	// build/validate write a validated-links.txt link cache into the book repo;
+	// make sure it's gitignored. Other commands don't touch the file, so they
+	// leave .gitignore alone.
+	if (["build", "validate"].includes(command.toLowerCase())) {
+		const gitignorePath = path.join(source_path, ".gitignore");
+		if (fs.existsSync(gitignorePath)) {
+			const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
+			if (!gitignoreContent.includes("validated-links.txt")) {
+				fs.appendFileSync(gitignorePath, "\nvalidated-links.txt\n");
+				console.info("Added validated-links.txt to .gitignore");
+			}
 		}
-	} 
+	}
 	
 	if (command.toLowerCase() === "serve") {
 		const server = require(path.join(__dirname, "hdoc-serve.js"));

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
 	"name": "hdoc-tools",
-	"version": "0.59.0",
+	"version": "0.61.0",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "hdoc-tools",
-			"version": "0.59.0",
+			"version": "0.61.0",
 			"hasInstallScript": true,
 			"license": "ISC",
 			"dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hdoc-tools",
-	"version": "0.60.1",
+	"version": "0.62.0",
 	"description": "Hornbill HDocBook Development Support Tool",
 	"main": "hdoc.js",
 	"bin": {
@@ -12,7 +12,6 @@
 		"hdoc-build.js",
 		"hdoc-build-db.js",
 		"hdoc-build-embeddings.js",
-		"hdoc-build-onyx.js",
 		"hdoc-build-pdf.js",
 		"hdoc-bump.js",
 		"hdoc-content-routes.js",
@@ -29,6 +28,7 @@
 		"hdoc-toc.js",
 		"hdoc-validate.js",
 		"hdoc-validate-config.js",
+		"hdoc-validate-interbook.js",
 		"hdoc-ver.js",
 		"validateNodeVer.js",
 		".puppeteerrc.cjs",
@@ -48,6 +48,17 @@
 	},
 	"author": "Hornbill Technologies Ltd",
 	"license": "ISC",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/hornbill/hdoc-tools.git"
+	},
+	"homepage": "https://github.com/hornbill/hdoc-tools#readme",
+	"bugs": {
+		"url": "https://github.com/hornbill/hdoc-tools/issues"
+	},
+	"engines": {
+		"node": ">=20"
+	},
 	"dependencies": {
 		"@huggingface/transformers": "3.8.1",
 		"@mermaid-js/layout-elk": "0.2.1",

package/schemas/hdocbook-project.schema.json

@@ -67,6 +67,26 @@
         "external_link_warnings": {
           "type": "boolean",
           "description": "When true, external link failures are reported as warnings rather than errors."
+        },
+        "spellcheckDictionary": {
+          "type": "array",
+          "description": "Words to exclude from the British English spellcheck across all documents in the book.",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "ai": {
+      "type": "object",
+      "description": "Configuration for the hdoc edit AI assist feature.",
+      "additionalProperties": false,
+      "properties": {
+        "model": {
+          "type": "string",
+          "description": "Anthropic model ID used by the hdoc edit AI assist feature."
+        },
+        "maxTokens": {
+          "type": "integer",
+          "description": "Maximum response tokens for AI assist requests."
         }
       }
     },

package/schemas/hdocbook.schema.json

@@ -4,7 +4,7 @@
   "title": "HDocBook Configuration",
   "description": "Schema for hdocbook.json - book metadata, navigation, and publishing configuration",
   "type": "object",
-  "required": ["docId", "title", "description", "version", "productFamily", "audience", "navigation"],
+  "required": ["docId", "title", "version", "productFamily", "audience", "navigation"],
   "additionalProperties": false,
   "properties": {
     "docId": {
@@ -98,7 +98,7 @@
       "properties": {
         "items": {
           "type": "array",
-          "description": "Top-level navigation items. Maximum three levels of nesting are supported.",
+          "description": "Top-level navigation items. Maximum five levels of nesting are supported.",
           "minItems": 1,
           "items": { "$ref": "#/$defs/navigationItem" }
         }
@@ -128,6 +128,10 @@
           "type": "string",
           "description": "Display text for the navigation item."
         },
+        "id": {
+          "type": "string",
+          "description": "Opaque node identifier written by the hdoc edit navigation editor. Optional."
+        },
         "link": {
           "type": "string",
           "description": "Path to the content page. Ignored when 'items' is present."

package/templates/doc-header-non-git.html

@@ -1,20 +1,20 @@
-<div class="document-header">
-    <div class="hb-container-horizontal">
-        <div class="hb-center-v hb-container-expand">
-            <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">{{breadcrumbs}}</ul>
-        </div> 
-        <div class="toolbar-right hb-center-v">
-        </div>
-    </div> 
-    
-    <h1>{{title}}</h1>
-    
-    <div class="hb-container-horizontal">
-        <div class="hb-center-v hb-container-expand">
-            <ul class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
-                <li class="ps-0 mt-0 nav-bar-item">{{doc-type}}</li>
-                <li class="ps-0 mt-0 nav-bar-item">{{reading-time}} minutes to read</li> 
-            </ul>
-        </div> 
-    </div>
+<div class="document-header">
+    <div class="hb-container-horizontal">
+        <div class="hb-center-v hb-container-expand">
+            <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">{{breadcrumbs}}</ul>
+        </div> 
+        <div class="toolbar-right hb-center-v">
+        </div>
+    </div> 
+    
+    <h1>{{title}}</h1>
+    
+    <div class="hb-container-horizontal">
+        <div class="hb-center-v hb-container-expand">
+            <ul class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
+                <li class="ps-0 mt-0 nav-bar-item">{{doc-type}}</li>
+                <li class="ps-0 mt-0 nav-bar-item">{{reading-time}} minutes to read</li> 
+            </ul>
+        </div> 
+    </div>
 </div>

package/templates/doc-header.html

@@ -1,27 +1,27 @@
-<div class="document-header">
-    <div class="hb-container-horizontal">
-        <div class="hb-center-v hb-container-expand">
-            <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">{{breadcrumbs}}</ul>
-        </div> 
-        <div class="toolbar-right hb-center-v">
-            <a target="_blank" class="toolbar-action" href="{{edit-url}}" aria-label="Edit this page on GitHub">
-                <i class="bi bi-pencil" aria-hidden="true"></i>
-            </a> 
-        </div>
-    </div> 
-    
-    <h1>{{title}}</h1>
-    
-    <div class="hb-container-horizontal">
-        <div class="hb-center-v hb-container-expand">
-            <ul class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
-                <li class="ps-0 mt-0 nav-bar-item">{{doc-type}}</li>
-                <li class="ps-0 mt-0 nav-bar-item">{{last-update}}</li>
-                <li class="ps-0 mt-0 nav-bar-item">{{reading-time}} minutes to read</li> 
-                <li class="ps-0 mt-0 nav-bar-item">
-                    <a class="link c-pointer" data-bs-toggle="modal" data-bs-target="#contributersModal">{{contributor-count}} contributors</a>
-                </li>
-            </ul>
-        </div> 
-    </div>
+<div class="document-header">
+    <div class="hb-container-horizontal">
+        <div class="hb-center-v hb-container-expand">
+            <ul class="ps-0 nav-bar-nav-list noeffects after-fslash overflow-ellipsis">{{breadcrumbs}}</ul>
+        </div> 
+        <div class="toolbar-right hb-center-v">
+            <a target="_blank" class="toolbar-action" href="{{edit-url}}" aria-label="Edit this page on GitHub">
+                <i class="bi bi-pencil" aria-hidden="true"></i>
+            </a> 
+        </div>
+    </div> 
+    
+    <h1>{{title}}</h1>
+    
+    <div class="hb-container-horizontal">
+        <div class="hb-center-v hb-container-expand">
+            <ul class="ps-0 nav-bar-nav-list noeffects after-bullets overflow-ellipsis text-light-2">
+                <li class="ps-0 mt-0 nav-bar-item">{{doc-type}}</li>
+                <li class="ps-0 mt-0 nav-bar-item">{{last-update}}</li>
+                <li class="ps-0 mt-0 nav-bar-item">{{reading-time}} minutes to read</li> 
+                <li class="ps-0 mt-0 nav-bar-item">
+                    <a class="link c-pointer" data-bs-toggle="modal" data-bs-target="#contributersModal">{{contributor-count}} contributors</a>
+                </li>
+            </ul>
+        </div> 
+    </div>
 </div>

package/templates/init/.github/workflows/hdocbuild_onpull.yml

@@ -1,17 +1,17 @@
-name: HDocBuildPull
-
-on:
-  # Triggers the workflow on pull request opened or reopened events
-  pull_request_target:
-    types: [opened, reopened]
-    paths-ignore:
-      - '.github/**'
-
-jobs:
-  call-workflow-pull-validate:
-    uses: Hornbill-Docs/hdoc-library/.github/workflows/hdocbuild_shared_pull.yml@main
-    with:
-      branch: ${{ github.event.pull_request.head.sha }}
-      server_url: ${{ github.server_url }}
-      repo: ${{ github.repository }}
+name: HDocBuildPull
+
+on:
+  # Triggers the workflow on pull request opened or reopened events
+  pull_request_target:
+    types: [opened, reopened]
+    paths-ignore:
+      - '.github/**'
+
+jobs:
+  call-workflow-pull-validate:
+    uses: Hornbill-Docs/hdoc-library/.github/workflows/hdocbuild_shared_pull.yml@main
+    with:
+      branch: ${{ github.event.pull_request.head.sha }}
+      server_url: ${{ github.server_url }}
+      repo: ${{ github.repository }}
       run_id: ${{ github.run_id }}

package/templates/init/.github/workflows/hdocbuild_onpush.yml

@@ -1,15 +1,15 @@
-name: HDocBuildPush
-on:
-  # Triggers the workflow on push requests
-  push:
-    paths-ignore:
-      - '.github/**'
-  
-  # Allows us to run this workflow manually from the Actions tab
-  workflow_dispatch:
-  
-jobs:
-  call-workflow-push-validate:
-    uses: Hornbill-Docs/hdoc-library/.github/workflows/hdocbuild_shared_push.yml@main
-    with:
-      branch: ${{ github.event.inputs.branch }}
+name: HDocBuildPush
+on:
+  # Triggers the workflow on push requests
+  push:
+    paths-ignore:
+      - '.github/**'
+  
+  # Allows us to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  
+jobs:
+  call-workflow-push-validate:
+    uses: Hornbill-Docs/hdoc-library/.github/workflows/hdocbuild_shared_push.yml@main
+    with:
+      branch: ${{ github.event.inputs.branch }}

package/templates/init/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Hornbill Docs
-
-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.
+MIT License
+
+Copyright (c) 2022 Hornbill Docs
+
+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/templates/init/README.md

@@ -1,9 +1,9 @@
-# HDocBook documentation
-This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
-
-Make sure that you have installed hdoc-tools   
-
-  npm install hdoc-tools -g
-
-To preview the documentation in a browser, you can open a terminal window and run the dev preview server with the 
-command `hdoc serve` and in a local browser go to the url `http://localhost:3000`
+# HDocBook documentation
+This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
+
+Make sure that you have installed hdoc-tools   
+
+  npm install hdoc-tools -g
+
+To preview the documentation in a browser, you can open a terminal window and run the dev preview server with the 
+command `hdoc serve` and in a local browser go to the url `http://localhost:3000`

package/templates/init/_hdocbook/index.md

@@ -1,5 +1,5 @@
----
-layout: article-toc
----
-# Welcome 
+---
+layout: article-toc
+---
+# Welcome 
 This is your first page

package/templates/init/gitignore

@@ -1,9 +1,9 @@
-_work/
-node_modules/
-package-lock.json
-.wsuo
-.DS_Store
-VSWorkspaceState.json
-slnx.state
-slnx.sqlite
+_work/
+node_modules/
+package-lock.json
+.wsuo
+.DS_Store
+VSWorkspaceState.json
+slnx.state
+slnx.sqlite
 validated-links.txt

package/templates/init/resources/README.md

@@ -1,3 +1,3 @@
-You should store any files and resources that used in the creation of this hdocbook, but do not form part of the published content.
-
+You should store any files and resources that used in the creation of this hdocbook, but do not form part of the published content.
+
 These files are included in the build and final content output but we should keep in the source code repo for future revisions.  For example, if you were to create an image used in the content, say, in Photoshop, you will create the image and put that into the appropriate content location.  However, you may also want to put the Photoshop source file into this **resources** folder in order to keep for the future, should anyone need to modify the image, we have the original source file.

package/templates/pdf/css/custom-block.css

@@ -1,90 +1,90 @@
-.custom-block {
-  border: 1px solid transparent;
-  border-radius: 8px;
-  padding: 16px 16px 8px;
-  line-height: 24px;
-  font-size: var(--htl-default-font-size);
-  color: var(--htl-c-text-2);
-}
-
-.custom-block.info {
-  border-color: var(--htl-custom-block-info-border);
-  color: var(--htl-custom-block-info-text);
-  background-color: var(--htl-custom-block-info-bg);
-}
-
-.custom-block.info code {
-  background-color: var(--htl-custom-block-info-code-bg);
-}
-
-.custom-block.tip {
-  border-color: var(--htl-custom-block-tip-border);
-  color: var(--htl-custom-block-tip-text);
-  background-color: var(--htl-custom-block-tip-bg);
-}
-
-.custom-block.tip code {
-  background-color: var(--htl-custom-block-tip-code-bg);
-}
-
-.custom-block.warning {
-  border-color: var(--htl-custom-block-warning-border);
-  color: var(--htl-custom-block-warning-text);
-  background-color: var(--htl-custom-block-warning-bg);
-}
-
-.custom-block.warning code {
-  background-color: var(--htl-custom-block-warning-code-bg);
-}
-
-.custom-block.danger {
-  border-color: var(--htl-custom-block-danger-border);
-  color: var(--htl-custom-block-danger-text);
-  background-color: var(--htl-custom-block-danger-bg);
-}
-
-.custom-block.danger code {
-  background-color: var(--htl-custom-block-danger-code-bg);
-}
-
-.custom-block.details {
-  border-color: var(--htl-custom-block-details-border);
-  color: var(--htl-custom-block-details-text);
-  background-color: var(--htl-custom-block-details-bg);
-}
-
-.custom-block.details code {
-  background-color: var(--htl-custom-block-details-code-bg);
-}
-
-.custom-block-title {
-  font-weight: 700;
-}
-
-.custom-block p + p {
-  margin: 8px 0;
-}
-
-.custom-block.details summary {
-  margin: 0 0 8px;
-  font-weight: 700;
-}
-
-.custom-block.details summary + p {
-  margin: 8px 0;
-}
-
-.custom-block a {
-  color: inherit;
-  font-weight: 600;
-  text-decoration: underline;
-  transition: opacity 0.25s;
-}
-
-.custom-block a:hover {
-  opacity: 0.6;
-}
-
-.custom-block code {
-  font-size: var(--htl-custom-block-code-font-size);
-}
+.custom-block {
+  border: 1px solid transparent;
+  border-radius: 8px;
+  padding: 16px 16px 8px;
+  line-height: 24px;
+  font-size: var(--htl-default-font-size);
+  color: var(--htl-c-text-2);
+}
+
+.custom-block.info {
+  border-color: var(--htl-custom-block-info-border);
+  color: var(--htl-custom-block-info-text);
+  background-color: var(--htl-custom-block-info-bg);
+}
+
+.custom-block.info code {
+  background-color: var(--htl-custom-block-info-code-bg);
+}
+
+.custom-block.tip {
+  border-color: var(--htl-custom-block-tip-border);
+  color: var(--htl-custom-block-tip-text);
+  background-color: var(--htl-custom-block-tip-bg);
+}
+
+.custom-block.tip code {
+  background-color: var(--htl-custom-block-tip-code-bg);
+}
+
+.custom-block.warning {
+  border-color: var(--htl-custom-block-warning-border);
+  color: var(--htl-custom-block-warning-text);
+  background-color: var(--htl-custom-block-warning-bg);
+}
+
+.custom-block.warning code {
+  background-color: var(--htl-custom-block-warning-code-bg);
+}
+
+.custom-block.danger {
+  border-color: var(--htl-custom-block-danger-border);
+  color: var(--htl-custom-block-danger-text);
+  background-color: var(--htl-custom-block-danger-bg);
+}
+
+.custom-block.danger code {
+  background-color: var(--htl-custom-block-danger-code-bg);
+}
+
+.custom-block.details {
+  border-color: var(--htl-custom-block-details-border);
+  color: var(--htl-custom-block-details-text);
+  background-color: var(--htl-custom-block-details-bg);
+}
+
+.custom-block.details code {
+  background-color: var(--htl-custom-block-details-code-bg);
+}
+
+.custom-block-title {
+  font-weight: 700;
+}
+
+.custom-block p + p {
+  margin: 8px 0;
+}
+
+.custom-block.details summary {
+  margin: 0 0 8px;
+  font-weight: 700;
+}
+
+.custom-block.details summary + p {
+  margin: 8px 0;
+}
+
+.custom-block a {
+  color: inherit;
+  font-weight: 600;
+  text-decoration: underline;
+  transition: opacity 0.25s;
+}
+
+.custom-block a:hover {
+  opacity: 0.6;
+}
+
+.custom-block code {
+  font-size: var(--htl-custom-block-code-font-size);
+}