Skip to content
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.

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

gen-markdown generator, for docs generation #248

Open
pkieltyka opened this issue Feb 23, 2024 · 1 comment
Open

gen-markdown generator, for docs generation #248

pkieltyka opened this issue Feb 23, 2024 · 1 comment
Labels
todo items we should do
Milestone

Comments

@pkieltyka
Copy link
Member

related to #246

once we have comments in our schema, we can generate pretty decent documentation from a webrpc schema definition (in either ridl or json of course, since they're the same just different formats).

I've added https://github.com/webrpc/gen-markdown which we can use to parse a single schema file, and output a markdown contents, which can be piped into a file, or can be used in a pipeline for example with any static site docs generator (ie. docusaurus, vocs.dev, etc. etc.), and then it makes it easy to have a "API Reference" section in docs which are generated by this gen-markdown with comments coming from the schema.

@pkieltyka pkieltyka added the todo items we should do label Feb 23, 2024
@pkieltyka pkieltyka added this to the next milestone Feb 23, 2024
@VojtechVitek
Copy link
Contributor

I found this OpenAPI->Markdown generator:

$ webrpc-gen -schema=./test.ridl -target=openapi -out=test.gen.yaml

$ docker run --rm -v "${PWD}:/app" openapitools/openapi-generator-cli:v6.2.1 generate -i /app/test.gen.yaml -g markdown -o /app/test.md

Screen Shot 2024-03-04 at 2 40 10 PM

It might do what we need for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
todo items we should do
Projects
None yet
Development

No branches or pull requests

2 participants