feat: this adds support for rendering with generateDocs

Author: zcstarr

bun.lock

@@ -37,6 +37,7 @@
         "@docusaurus/utils": "3.9.2",
         "@docusaurus/utils-common": "3.9.2",
         "@docusaurus/utils-validation": "3.9.2",
+        "@open-rpc/markdown-generator": "workspace:*",
         "@open-rpc/meta-schema": "^1.14.9",
         "@open-rpc/schema-utils-js": "^2.1.2",
       },
@@ -91,10 +92,11 @@
       },
     },
     "packages/markdown-generator": {
-      "name": "markdown-gen",
+      "name": "@open-rpc/markdown-generator",
       "version": "0.0.0-development",
       "dependencies": {
         "@open-rpc/json-schema-renderer": "workspace:*",
+        "@open-rpc/schema-utils-js": "^2.1.2",
         "@types/mdast": "^4.0.4",
       },
       "devDependencies": {
@@ -601,6 +603,8 @@
 
     "@open-rpc/json-schema-renderer": ["@open-rpc/json-schema-renderer@workspace:packages/json-schema-renderer"],
 
+    "@open-rpc/markdown-generator": ["@open-rpc/markdown-generator@workspace:packages/markdown-generator"],
+
     "@open-rpc/meta-schema": ["@open-rpc/[email protected]", "", {}, "sha512-2/CbDzOVpcaSnMs28TsRv8MKJwJi0TTYFlQ6q6qobAH26oIuhYgcZooKf4l71emgntU6MMcFQCA0h4mJ4dBCdA=="],
 
     "@open-rpc/schema-utils-js": ["@open-rpc/[email protected]", "", { "dependencies": { "@json-schema-tools/dereferencer": "^1.6.3", "@json-schema-tools/meta-schema": "^1.7.5", "@json-schema-tools/reference-resolver": "^1.2.6", "@open-rpc/meta-schema": "^1.14.9", "@open-rpc/specification-extension-spec": "^1.0.2", "ajv": "^6.10.0", "detect-node": "^2.0.4", "fast-safe-stringify": "^2.0.7", "fs-extra": "^10.1.0", "is-url": "^1.2.4", "isomorphic-fetch": "^3.0.0" } }, "sha512-GQT+UQSBg/xoPW3NMr7a9YV9iype0DlSYUocCb1qe4IvgJk9HX6KPfXwSVCNr0S7o4fJpc6A80azqODqfkJXMQ=="],
@@ -1549,8 +1553,6 @@
 
     "markdown-extensions": ["[email protected]", "", {}, "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q=="],
 
-    "markdown-gen": ["markdown-gen@workspace:packages/markdown-generator"],
-
     "markdown-table": ["[email protected]", "", {}, "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw=="],
 
     "marked": ["[email protected]", "", { "bin": { "marked": "bin/marked.js" } }, "sha512-TI3V8YYWvkVf3KJe1dRkpnjs68JUPyEa5vjKrp1XEEJUAOaQc+Qj+L1qWbPd0SJuAdQkFU0h73sXXqwDYxsiDA=="],

packages/docusaurus-plugin/src/lib.ts

@@ -6,6 +6,13 @@ import {
   MethodObjectParams,
 } from "@open-rpc/meta-schema";
 
+import type { Edits, SchemaEdits } from "@open-rpc/markdown-generator";
+import {
+  identityEdits,
+  identitySchemaEdits,
+  renderMethodsToMarkdown,
+} from "@open-rpc/markdown-generator";
+
 import { promises as fs } from "fs";
 
 import * as path from "path";
@@ -63,6 +70,12 @@ export async function generateDocs(inputPath: string, outputPath: string) {
     raw,
   )) as DereffedOpenrpcDocument;
 
+  const methods = await renderMethodsToMarkdown(
+    doc,
+    identityEdits,
+    identitySchemaEdits,
+  );
+
   const outDir = outputPath;
   const methodsDir = path.join(outDir, "methods");
   const schemasDir = path.join(outDir, "schemas");
@@ -73,10 +86,10 @@ export async function generateDocs(inputPath: string, outputPath: string) {
 
   await fs.writeFile(path.join(outDir, "index.md"), renderIndex(doc), "utf8");
 
-  for (const m of doc.methods) {
+  for (const m of methods) {
     await fs.writeFile(
-      path.join(methodsDir, `${m.name}.mdx`),
-      renderMethod(m),
+      path.join(methodsDir, `${m.methodName}.mdx`),
+      m.markdown,
       "utf8",
     );
   }