Merge pull request #573 from ShaggyTech/typedoc-plugin-markdown

typedoc-plugin-markdown@next

Author: ShaggyTech

apps/docs/.prettierignore

@@ -0,0 +1 @@
+**/typedoc/**

apps/docs/.vitepress/config.ts

@@ -42,10 +42,6 @@ export default withPwa(
       outline: 'deep',
       nav: nav(),
       sidebar: sidebar(),
-
-      // search: {
-      //   provider: 'local',
-      // },
       algolia: getAlgoliaConfig(process.env),
 
       editLink: {

apps/docs/.vitepress/menu-links.ts

@@ -76,168 +76,150 @@ const vpicEndpointLinks = [
 
 const typedocLinks = [
   {
-    text: 'Modules',
+    text: '/api',
     collapsed: true,
     items: [
+      { text: 'Index', link: '/typedoc/api' },
       {
-        text: '/api',
+        text: 'useNHTSA',
+        link: '/typedoc/api/useNHTSA',
+      },
+      {
+        text: '/endpoints/',
         collapsed: true,
         items: [
-          { text: 'Index', link: '/typedoc/modules/api' },
+          { text: 'Index', link: '/typedoc/api/endpoints' },
           {
-            text: 'useNHTSA',
-            link: '/typedoc/modules/api_useNHTSA',
+            text: 'DecodeVin',
+            link: '/typedoc/api/endpoints/DecodeVin',
           },
           {
-            text: '/endpoints/',
-            collapsed: true,
-            items: [
-              { text: 'Index', link: '/typedoc/modules/api_endpoints' },
-              {
-                text: 'DecodeVin',
-                link: '/typedoc/modules/api_endpoints_DecodeVin',
-              },
-              {
-                text: 'DecodeVinExtended',
-                link: '/typedoc/modules/api_endpoints_DecodeVinExtended',
-              },
-              {
-                text: 'DecodeVinValues',
-                link: '/typedoc/modules/api_endpoints_DecodeVinValues',
-              },
-              {
-                text: 'DecodeVinValuesBatch',
-                link: '/typedoc/modules/api_endpoints_DecodeVinValuesBatch',
-              },
-              {
-                text: 'DecodeVinValuesExtended',
-                link: '/typedoc/modules/api_endpoints_DecodeVinValuesExtended',
-              },
-              {
-                text: 'DecodeWMI',
-                link: '/typedoc/modules/api_endpoints_DecodeWMI',
-              },
-              {
-                text: 'GetAllMakes',
-                link: '/typedoc/modules/api_endpoints_GetAllMakes',
-              },
-              {
-                text: 'GetAllManufacturers',
-                link: '/typedoc/modules/api_endpoints_GetAllManufacturers',
-              },
-              {
-                text: 'GetCanadianVehicleSpecifications',
-                link: '/typedoc/modules/api_endpoints_GetCanadianVehicleSpecifications',
-              },
-              {
-                text: 'GetEquipmentPlantCodes',
-                link: '/typedoc/modules/api_endpoints_GetEquipmentPlantCodes',
-              },
-              {
-                text: 'GetMakeForManufacturer',
-                link: '/typedoc/modules/api_endpoints_GetMakeForManufacturer',
-              },
-              {
-                text: 'GetMakesForManufacturerAndYear',
-                link: '/typedoc/modules/api_endpoints_GetMakesForManufacturerAndYear',
-              },
-              {
-                text: 'GetMakesForVehicleType',
-                link: '/typedoc/modules/api_endpoints_GetMakesForVehicleType',
-              },
-              {
-                text: 'GetManufacturerDetails',
-                link: '/typedoc/modules/api_endpoints_GetManufacturerDetails',
-              },
-              {
-                text: 'GetModelsForMake',
-                link: '/typedoc/modules/api_endpoints_GetModelsForMake',
-              },
-              {
-                text: 'GetModelsForMakeId',
-                link: '/typedoc/modules/api_endpoints_GetModelsForMakeId',
-              },
-              {
-                text: 'GetModelsForMakeIdYear',
-                link: '/typedoc/modules/api_endpoints_GetModelsForMakeIdYear',
-              },
-              {
-                text: 'GetModelsForMakeYear',
-                link: '/typedoc/modules/api_endpoints_GetModelsForMakeYear',
-              },
-              {
-                text: 'GetParts',
-                link: '/typedoc/modules/api_endpoints_GetParts',
-              },
-              {
-                text: 'GetVehicleTypesForMake',
-                link: '/typedoc/modules/api_endpoints_GetVehicleTypesForMake',
-              },
-              {
-                text: 'GetVehicleTypesForMakeId',
-                link: '/typedoc/modules/api_endpoints_GetVehicleTypesForMakeId',
-              },
-              {
-                text: 'GetVehicleVariableList',
-                link: '/typedoc/modules/api_endpoints_GetVehicleVariableList',
-              },
-              {
-                text: 'GetVehicleVariableValuesList',
-                link: '/typedoc/modules/api_endpoints_GetVehicleVariableValuesList',
-              },
-              {
-                text: 'GetWMIsForManufacturer',
-                link: '/typedoc/modules/api_endpoints_GetWMIsForManufacturer',
-              },
-            ],
+            text: 'DecodeVinExtended',
+            link: '/typedoc/api/endpoints/DecodeVinExtended',
+          },
+          {
+            text: 'DecodeVinValues',
+            link: '/typedoc/api/endpoints/DecodeVinValues',
+          },
+          {
+            text: 'DecodeVinValuesBatch',
+            link: '/typedoc/api/endpoints/DecodeVinValuesBatch',
+          },
+          {
+            text: 'DecodeVinValuesExtended',
+            link: '/typedoc/api/endpoints/DecodeVinValuesExtended',
+          },
+          {
+            text: 'DecodeWMI',
+            link: '/typedoc/api/endpoints/DecodeWMI',
+          },
+          {
+            text: 'GetAllMakes',
+            link: '/typedoc/api/endpoints/GetAllMakes',
+          },
+          {
+            text: 'GetAllManufacturers',
+            link: '/typedoc/api/endpoints/GetAllManufacturers',
+          },
+          {
+            text: 'GetCanadianVehicleSpecifications',
+            link: '/typedoc/api/endpoints/GetCanadianVehicleSpecifications',
+          },
+          {
+            text: 'GetEquipmentPlantCodes',
+            link: '/typedoc/api/endpoints/GetEquipmentPlantCodes',
+          },
+          {
+            text: 'GetMakeForManufacturer',
+            link: '/typedoc/api/endpoints/GetMakeForManufacturer',
           },
-        ],
-      },
-      {
-        text: '/utils',
-        collapsed: true,
-        items: [
-          { text: 'Index', link: '/typedoc/modules/utils' },
           {
-            text: 'argHandler',
-            link: '/typedoc/modules/utils_argHandler',
+            text: 'GetMakesForManufacturerAndYear',
+            link: '/typedoc/api/endpoints/GetMakesForManufacturerAndYear',
           },
           {
-            text: 'errorHandler',
-            link: '/typedoc/modules/utils_errorHandler',
+            text: 'GetMakesForVehicleType',
+            link: '/typedoc/api/endpoints/GetMakesForVehicleType',
           },
           {
-            text: 'getTypeof',
-            link: '/typedoc/modules/utils_getTypeof',
+            text: 'GetManufacturerDetails',
+            link: '/typedoc/api/endpoints/GetManufacturerDetails',
           },
           {
-            text: 'isValidVin',
-            link: '/typedoc/modules/utils_isValidVin',
+            text: 'GetModelsForMake',
+            link: '/typedoc/api/endpoints/GetModelsForMake',
           },
           {
-            text: 'queryString',
-            link: '/typedoc/modules/utils_queryString',
+            text: 'GetModelsForMakeId',
+            link: '/typedoc/api/endpoints/GetModelsForMakeId',
+          },
+          {
+            text: 'GetModelsForMakeIdYear',
+            link: '/typedoc/api/endpoints/GetModelsForMakeIdYear',
+          },
+          {
+            text: 'GetModelsForMakeYear',
+            link: '/typedoc/api/endpoints/GetModelsForMakeYear',
+          },
+          {
+            text: 'GetParts',
+            link: '/typedoc/api/endpoints/GetParts',
+          },
+          {
+            text: 'GetVehicleTypesForMake',
+            link: '/typedoc/api/endpoints/GetVehicleTypesForMake',
+          },
+          {
+            text: 'GetVehicleTypesForMakeId',
+            link: '/typedoc/api/endpoints/GetVehicleTypesForMakeId',
+          },
+          {
+            text: 'GetVehicleVariableList',
+            link: '/typedoc/api/endpoints/GetVehicleVariableList',
+          },
+          {
+            text: 'GetVehicleVariableValuesList',
+            link: '/typedoc/api/endpoints/GetVehicleVariableValuesList',
+          },
+          {
+            text: 'GetWMIsForManufacturer',
+            link: '/typedoc/api/endpoints/GetWMIsForManufacturer',
           },
         ],
       },
     ],
   },
   {
-    text: 'Types',
+    text: '/utils',
     collapsed: true,
     items: [
-      { text: 'Index', link: '/typedoc/modules/types' },
-      { text: '/api/types', link: '/typedoc/modules/api_types' },
+      { text: 'Index', link: '/typedoc/utils' },
+      {
+        text: 'argHandler',
+        link: '/typedoc/utils/argHandler',
+      },
       {
-        text: '/api/endpoints/types',
-        link: '/typedoc/modules/api_endpoints_types',
+        text: 'errorHandler',
+        link: '/typedoc/utils/errorHandler',
       },
       {
-        text: '/utils/types',
-        link: '/typedoc/modules/utils_types',
+        text: 'getTypeof',
+        link: '/typedoc/utils/getTypeof',
+      },
+      {
+        text: 'isValidVin',
+        link: '/typedoc/utils/isValidVin',
+      },
+      {
+        text: 'queryString',
+        link: '/typedoc/utils/queryString',
       },
     ],
   },
+  {
+    text: 'Types Index',
+    link: '/typedoc/types',
+  },
 ]
 
 export type LinkGroup = 'guide' | 'api' | 'typedocs'

apps/docs/package.json

@@ -12,7 +12,7 @@
     "preview": "vitepress preview",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "format": "prettier --write \"src/**/*.{ts,tsx,md}\"",
+    "format": "prettier --write \"src/**/*.{js,ts,md}\"",
     "format:typedoc": "prettier --write \"src/typedoc/**/*.md\"",
     "clean": "rimraf .vitepress/dist .vitepress/cache .turbo",
     "clean:all": "pnpm run clean && rimraf node_modules"

apps/docs/src/api/endpoints/decode-vin-extended.md

@@ -15,7 +15,7 @@ async function DecodeVinExtended (
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinExtended)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeVinExtended)
 :::
 
 ## Description

apps/docs/src/api/endpoints/decode-vin-values-batch.md

@@ -10,7 +10,7 @@ async function DecodeVinValuesBatch(
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValuesBatch)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesBatch)
 :::
 
 ## Description

apps/docs/src/api/endpoints/decode-vin-values-extended.md

@@ -15,7 +15,7 @@ async function DecodeVinValuesExtended(
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValuesExtended)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValuesExtended)
 :::
 
 ## Description

apps/docs/src/api/endpoints/decode-vin-values.md

@@ -15,7 +15,7 @@ async function DecodeVinValues(
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVinValues)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeVinValues)
 :::
 
 ## Description

apps/docs/src/api/endpoints/decode-vin.md

@@ -15,7 +15,7 @@ async function DecodeVin(
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeVin)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeVin)
 :::
 
 ## Description

apps/docs/src/api/endpoints/decode-wmi.md

@@ -10,7 +10,7 @@ async function DecodeWMI(
 ```
 
 ::: tip :bulb: More In Depth
-See: [Package Reference](../../typedoc/modules/api_endpoints_DecodeWMI)
+See: [Package Reference](../../typedoc/api/endpoints/DecodeWMI)
 :::
 
 ## Description