cp dines

Author: dines-rl

.gitignore

@@ -13,3 +13,4 @@ dist-deno
 coverage-objects
 object-coverage-report.json
 docs
+docs-md

package.json

@@ -30,6 +30,7 @@
     "lint": "./scripts/lint",
     "fix": "./scripts/format",
     "docs": "typedoc --options typedoc.json",
+    "docs:md": "typedoc --options typedoc.md.json",
     "docs:watch": "typedoc --options typedoc.json --watch",
     "predeploy-gh-pages": "yarn docs:sdk",
     "deploy-gh-pages": "gh-pages -d typedoc"
@@ -41,7 +42,9 @@
     "agentkeepalive": "^4.2.1",
     "form-data-encoder": "1.7.2",
     "formdata-node": "^4.3.2",
+    "i": "^0.3.7",
     "node-fetch": "^2.6.7",
+    "npm": "^11.6.2",
     "uuidv7": "^1.0.2",
     "zod": "^3.24.1"
   },
@@ -70,8 +73,10 @@
     "typedoc": "^0.28.14",
     "typedoc-github-theme": "^0.3.1",
     "typedoc-material-theme": "^1.4.1",
+    "typedoc-plugin-dt-links": "^2.0.29",
     "typedoc-plugin-include-example": "^3.0.2",
     "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-md": "^0.7.1",
     "typedoc-plugin-pages": "^1.1.0",
     "typescript": "^5.9.0"
   },

typedoc.json

@@ -6,7 +6,7 @@
   "tsconfig": "tsconfig.typedoc.json",
   "includeVersion": true,
   "readme": "README-SDK.md",
-  "plugin": ["typedoc-github-theme", "@shipgirl/typedoc-plugin-versions"],
+  "plugin": ["typedoc-github-theme", "@shipgirl/typedoc-plugin-versions", "typedoc-plugin-dt-links"],
   "navigation": {
     "includeCategories": true,
     "includeGroups": true

typedoc.md.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/sdk.ts"],
+  "entryPointStrategy": "expand",
+  "out": "docs-md/",
+  "tsconfig": "tsconfig.typedoc.json",
+  "includeVersion": true,
+  "plugin": ["typedoc-plugin-markdown"],
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true
+  },
+  "categorizeByGroup": true,
+  "searchInComments": true,
+  "sort": ["source-order"],
+  "kindSortOrder": [
+    "Project",
+    "Module",
+    "Enum",
+    "Class",
+    "Namespace",
+    "Interface",
+    "TypeAlias",
+    "Constructor",
+    "Property",
+    "Method",
+    "Accessor",
+    "Function",
+    "Variable"
+  ],
+  "visibilityFilters": {
+    "protected": false,
+    "private": false,
+    "inherited": true,
+    "external": true
+  },
+  "excludeTags": ["@hidden"],
+  "validation": {
+    "invalidLink": true,
+    "notDocumented": false
+  },
+  "externalSymbolLinkMappings": {
+    "@runloop/api-client": {
+      "BlobLikePart": "#"
+    }
+  },
+  "navigationLinks": {
+    "GitHub": "https://github.com/runloopai/api-client-ts",
+    "Documentation": "https://docs.runloop.ai"
+  }
+}