Skip to content

Feat/edits #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zcstarr merged 6 commits into from
Dec 19, 2025
Merged

Feat/edits #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
04cc664
feat: implement the rest of the edit interfaces and add md customization
zcstarr Dec 19, 2025
9ea7e0f
fix: cli with missing deps and proper md/mdx translation
zcstarr Dec 19, 2025
ffc1e7c
chore: fix tests to reflect updated interface
zcstarr Dec 19, 2025
a152a9b
chore: rm hardcoded test pure markdown render
zcstarr Dec 19, 2025
a297a75
chore: add docs to update
zcstarr Dec 19, 2025
b9d85ae
chore: add changeset
zcstarr Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/strict-sloths-play.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@open-rpc/markdown-generator": patch
"@open-rpc/docusaurus-plugin": patch
---

Changes here fix bugs with the edits interface, adds missing cli deps, and adds support for a more pure markdown output
5 changes: 4 additions & 1 deletion bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 5 additions & 6 deletions packages/docusaurus-plugin/src/lib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { parseOpenRPCDocument } from "@open-rpc/schema-utils-js";
import type { Edits } from "@open-rpc/markdown-generator";
import type { Edits, SchemaEdits } from "@open-rpc/markdown-generator";
import {
identityEdits,
identitySchemaEdits,
Expand All @@ -21,6 +21,9 @@ type JSONSchema = any;

const reactComponent: string = `import {TwoColumnLayout, InteractiveRequest, ResponseExample} from '@open-rpc/docusaurus-plugin/components';\nimport { useState } from 'react';`;
const methodEdits: Edits = { ...identityEdits };
const schemaEdits: SchemaEdits = {
...identitySchemaEdits,
};

methodEdits.editMethod = (content, method) => {
const m = method as DereffedMethodObject;
Expand Down Expand Up @@ -60,11 +63,7 @@ export async function generateDocs(inputPath: string, outputPath: string) {
raw,
)) as DereffedOpenrpcDocument;

const methods = await renderMethodsToMarkdown(
doc,
methodEdits,
identitySchemaEdits,
);
const methods = await renderMethodsToMarkdown(doc, schemaEdits, methodEdits);

const outDir = outputPath;
const methodsDir = path.join(outDir, "methods");
Expand Down
Loading
Loading