chore: generate node spec typedocs script (#443)

* chore: generate node spec typedocs script
NiceNode · Dec 5, 2023 · 14b03d3 · 14b03d3
1 parent 2e05c26
commit 14b03d3
Show file tree

Hide file tree

Showing 5 changed files with 662 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -40,3 +40,6 @@ src/__tests__/node/NiceNode/*
 
 # storybook build files
 storybook-static
+
+# docs for docs.nicenode.xyz
+docs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,6 +9,7 @@
     "build": "concurrently \"npm run build:main\" \"npm run build:renderer\"",
     "build:main": "cross-env NODE_ENV=production TS_NODE_TRANSPILE_ONLY=true webpack --config ./.erb/configs/webpack.config.main.prod.ts",
     "build:renderer": "cross-env NODE_ENV=production TS_NODE_TRANSPILE_ONLY=true webpack --config ./.erb/configs/webpack.config.renderer.prod.ts",
+    "docs:nodeSpec": "typedoc --plugin typedoc-plugin-markdown --name \"Node Spec examples\" --readme src/common/index.md --entryDocument index.md --out docs src/common/*",
     "rebuild": "electron-rebuild --parallel --types prod,dev,optional --module-dir release/app",
     "lint": "cross-env NODE_ENV=development eslint . --ext .js,.jsx,.ts,.tsx",
     "package": "ts-node ./.erb/scripts/clean.js dist && npm run build && electron-builder build --publish never",
@@ -310,6 +311,8 @@
     "ts-jest": "^29.0.3",
     "ts-loader": "^9.4.2",
     "ts-node": "^10.9.1",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.1.6",
     "url-loader": "^4.1.1",
     "webpack": "^5.88.2",

diff --git a/src/common/NodeSpecs/index.md b/src/common/NodeSpecs/index.md