docs: Build scripts docs in docs workspace

kitten-science · Jan 7, 2023 · 4871f38 · 4871f38
1 parent d5806f3
commit 4871f38
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -37,7 +37,6 @@
     "eslint": "8.31.0",
     "eslint-plugin-jsdoc": "39.6.4",
     "lint-staged": "13.1.0",
-    "node-scripts-docs": "0.0.14",
     "prettier": "2.8.1",
     "prettier-package-json": "2.8.0",
     "prettier-plugin-organize-imports": "3.2.1",

diff --git a/package.json-scripts.json b/package.json-scripts.json
@@ -33,6 +33,14 @@
       "isGlobal": true,
       "isRootManifest": false
     },
+    {
+      "manifestPath": "packages/documentation/package.json",
+      "projectName": "@kitten-science/documentation",
+      "scriptName": "docs:nsd",
+      "scriptCode": "nsd --cwd=$INIT_CWD --docs-location=\"packages/documentation/docs/reference/Repository Scripts/\"",
+      "isGlobal": true,
+      "isRootManifest": false
+    },
     {
       "manifestPath": "packages/documentation/package.json",
       "projectName": "@kitten-science/documentation",

diff --git a/packages/documentation/docs/reference/Repository Scripts/.docs$$nsd.md b/packages/documentation/docs/reference/Repository Scripts/.docs$$nsd.md
@@ -0,0 +1,12 @@
+## docs:nsd
+
+-   Project: `@kitten-science/documentation`
+-   Source:
+
+    ```shell
+    nsd --cwd=$INIT_CWD --docs-location="packages/documentation/docs/reference/Repository Scripts/"
+    ```
+
+-   Description:
+
+    _documentation pending_
diff --git a/packages/documentation/docs/reference/Repository Scripts/index.md b/packages/documentation/docs/reference/Repository Scripts/index.md
@@ -52,6 +52,19 @@
 
     _documentation pending_
 
+## docs:nsd
+
+-   Project: `@kitten-science/documentation`
+-   Source:
+
+    ```shell
+    nsd --cwd=$INIT_CWD --docs-location="packages/documentation/docs/reference/Repository Scripts/"
+    ```
+
+-   Description:
+
+    _documentation pending_
+
 ## docs:serve
 
 -   Project: `@kitten-science/documentation`

diff --git a/packages/documentation/package.json b/packages/documentation/package.json
@@ -8,8 +8,12 @@
   "main": "Dockerfile",
   "scripts": {
     "docs:build": ".scripts/build.sh",
+    "docs:nsd": "nsd --cwd=$INIT_CWD --docs-location=\"packages/documentation/docs/reference/Repository Scripts/\"",
     "docs:serve": ".scripts/serve.sh"
   },
+  "devDependencies": {
+    "node-scripts-docs": "0.0.14"
+  },
   "engines": {
     "node": "^16"
   }

diff --git a/yarn.lock b/yarn.lock
@@ -692,6 +692,8 @@ __metadata:
 "@kitten-science/documentation@workspace:packages/documentation":
   version: 0.0.0-use.local
   resolution: "@kitten-science/documentation@workspace:packages/documentation"
+  dependencies:
+    node-scripts-docs: 0.0.14
   languageName: unknown
   linkType: soft
 
@@ -3116,7 +3118,6 @@ __metadata:
     eslint: 8.31.0
     eslint-plugin-jsdoc: 39.6.4
     lint-staged: 13.1.0
-    node-scripts-docs: 0.0.14
     prettier: 2.8.1
     prettier-package-json: 2.8.0
     prettier-plugin-organize-imports: 3.2.1