hdoc-tools 0.7.14 → 0.7.16

package/README.md

@@ -1,9 +1,51 @@
-# HDocBook documentation
-This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
+# hdoc-tools
 
-Make sure that you have installed hdoc-tools   
+Hornbill HDocBook Development Support Tool.
 
-  npm install hdoc-tools -g
+## Usage
+
+<code>hdoc argument switches</code>
+
+## Arguments
+
+The arguments available to this command-line tool are as follows.
+
+### help
+
+Outputs available arguments and switches.
+
+### init
+
+Initializes a new HDocBook project from a template, using runtime input variables.
+
+### stats
+
+Returns statistics regarding the book you are working on:
+
+- Document ID
+- Version
+- Title
+- Description
+- Public Source
+- Total Book Word Count
+- Number of Markdown Files in the Book
+- Number of Static HTML Files in the Book
+
+If the -v switch is provided, then a more verbose output is output, which includes a list of each MD and HTML file found, the file sizes, and file-specific word count.
+
+### build
+
+Performs a local build of the book, validates the links and static content are present and correct, and outputs as a ZIP file.
+
+If the -v switch is provided, then a more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
+
+### serve
+
+Starts a local web server on port 3000, serving the book content.
 
 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`
+
+## Installation
+
+  npm install hdoc-tools -g

package/hdoc-build.js

@@ -123,7 +123,7 @@
         console.log(`             Failed to convert: ${conversion_failed}`);
 
         console.log(`\r\nValidating paths in generated HTML files`);
-        const validation_success = validate.run(work_path, verbose);
+        const validation_success = validate.run(work_path, docId, verbose);
         if (!validation_success) {
             process.exit(1);
         }

package/hdoc-validate.js

@@ -90,7 +90,7 @@ const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destina
     };
 
 
-    exports.run = function (source_path, verbose) {
+    exports.run = function (source_path, doc_id, verbose) {
         // Get a list of HTML files in source_path
         dree.scan(source_path, dreeOptions, fileCallback);
 
@@ -116,7 +116,7 @@ const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destina
         }
         try {
             // Write list
-            const listFile = path.join(source_path, 'list.txt');
+            const listFile = path.join(source_path, doc_id, 'list.txt');
             fs.writeFileSync(listFile, listContent);
             console.log(`${listFile} created successfully`);
         } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.7.14",
+  "version": "0.7.16",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {