hdoc-tools 0.11.6 → 0.11.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/hdoc-build-db.js +152 -152
- package/hdoc-build-pdf.js +172 -172
- package/hdoc-build.js +9 -1
- package/hdoc-bump.js +108 -108
- package/hdoc-create.js +90 -90
- package/hdoc-db.js +94 -94
- package/hdoc-help.js +49 -49
- package/hdoc-module.js +390 -390
- package/hdoc-validate.js +548 -548
- package/hdoc-ver.js +42 -42
- package/package.json +1 -1
- package/templates/doc-header-non-git.html +22 -22
- package/templates/doc-header.html +29 -29
- package/templates/pdf/css/custom-block.css +90 -90
- package/templates/pdf/css/fonts.css +221 -221
- package/templates/pdf/css/hdocs-pdf.css +246 -246
- package/templates/pdf/css/vars.css +393 -393
- package/templates/pdf/template-footer.html +19 -19
- package/templates/pdf/template-header.html +37 -37
- package/templates/pdf/template.html +20 -20
- package/templates/pdf-header-non-git.html +12 -12
- package/templates/pdf-header.html +16 -16
- package/validateNodeVer.js +12 -12
- package/LICENSE +0 -21
- package/templates/init/.npmignore +0 -7
package/hdoc-help.js
CHANGED
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
(function () {
|
|
2
|
-
'use strict';
|
|
3
|
-
|
|
4
|
-
exports.run = function () {
|
|
5
|
-
|
|
6
|
-
// STEVE: The purpose of this function is to output information about hdoc arguments
|
|
7
|
-
const helpText = `
|
|
8
|
-
Command Line Usage
|
|
9
|
-
|
|
10
|
-
hdoc <command> [switches]
|
|
11
|
-
|
|
12
|
-
Commands
|
|
13
|
-
|
|
14
|
-
- build
|
|
15
|
-
Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
|
|
16
|
-
|
|
17
|
-
- createDocs
|
|
18
|
-
Creates folder structure and markdown documents as defined in the HDocBook navigation item links
|
|
19
|
-
|
|
20
|
-
- help
|
|
21
|
-
Outputs available arguments and switches
|
|
22
|
-
|
|
23
|
-
- init
|
|
24
|
-
Initializes a new HDocBook project from a template, using runtime input variables
|
|
25
|
-
|
|
26
|
-
- serve
|
|
27
|
-
Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
|
|
28
|
-
|
|
29
|
-
- stats
|
|
30
|
-
Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
|
|
31
|
-
|
|
32
|
-
- validate
|
|
33
|
-
Validates the book content
|
|
34
|
-
|
|
35
|
-
- bump
|
|
36
|
-
Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
|
|
37
|
-
- major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
|
|
38
|
-
- minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
|
|
39
|
-
- patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
|
|
40
|
-
|
|
41
|
-
- ver
|
|
42
|
-
Returns the version of the current book
|
|
43
|
-
|
|
44
|
-
Example
|
|
45
|
-
|
|
46
|
-
hdoc stats -v
|
|
47
|
-
`;
|
|
48
|
-
console.log(helpText);
|
|
49
|
-
};
|
|
1
|
+
(function () {
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
exports.run = function () {
|
|
5
|
+
|
|
6
|
+
// STEVE: The purpose of this function is to output information about hdoc arguments
|
|
7
|
+
const helpText = `
|
|
8
|
+
Command Line Usage
|
|
9
|
+
|
|
10
|
+
hdoc <command> [switches]
|
|
11
|
+
|
|
12
|
+
Commands
|
|
13
|
+
|
|
14
|
+
- build
|
|
15
|
+
Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
|
|
16
|
+
|
|
17
|
+
- createDocs
|
|
18
|
+
Creates folder structure and markdown documents as defined in the HDocBook navigation item links
|
|
19
|
+
|
|
20
|
+
- help
|
|
21
|
+
Outputs available arguments and switches
|
|
22
|
+
|
|
23
|
+
- init
|
|
24
|
+
Initializes a new HDocBook project from a template, using runtime input variables
|
|
25
|
+
|
|
26
|
+
- serve
|
|
27
|
+
Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
|
|
28
|
+
|
|
29
|
+
- stats
|
|
30
|
+
Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
|
|
31
|
+
|
|
32
|
+
- validate
|
|
33
|
+
Validates the book content
|
|
34
|
+
|
|
35
|
+
- bump
|
|
36
|
+
Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
|
|
37
|
+
- major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
|
|
38
|
+
- minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
|
|
39
|
+
- patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
|
|
40
|
+
|
|
41
|
+
- ver
|
|
42
|
+
Returns the version of the current book
|
|
43
|
+
|
|
44
|
+
Example
|
|
45
|
+
|
|
46
|
+
hdoc stats -v
|
|
47
|
+
`;
|
|
48
|
+
console.log(helpText);
|
|
49
|
+
};
|
|
50
50
|
})();
|