docs: generate from jsdoc comments

nwutils · Jun 30, 2023 · 3848a2e · 3848a2e
1 parent 7a1af62
commit 3848a2e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/doc/.vitepress/config.js b/doc/.vitepress/config.js
@@ -39,6 +39,10 @@ export default defineConfig({
             text: "Windows Specific Options",
             link: "/api-win.md#winrc-object",
           },
+          {
+            text: "MacOS Specific Options",
+            link: "/api-osx.md#osxrc-object",
+          },
         ],
       },
       {

diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
     "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
-    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md",
+    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md && jsdoc2md ./src/bld/osxCfg.js > ./doc/api-osx.md",
     "doc:dev": "vitepress dev doc",
     "doc:bld": "vitepress build doc",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",

diff --git a/test/fixture/demo.js b/test/fixture/demo.js
@@ -6,7 +6,4 @@ await nwbuild({
   platform: "osx",
   outDir: "out",
   glob: false,
-  app: {
-    name: "Random",
-  },
 });