-
Notifications
You must be signed in to change notification settings - Fork 115
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
Add better example schemas and custom page docs #147
Comments
@rohit-gohri not sure if "custom page docs" is what I'm trying to do but here's my topic: There doesn't seem to be any docs to embed regular markdown docs into the generated api docs, e.g., to show an "introduction" page before showing the specfile contents. Is this even possible? |
Do you mean importing a markdown file in the info.description section of the openapi yaml? |
I mean adding a page that is is own element in the generated sidebar. EDIT: nevermind, wasn't sure on how you were meant to integrate the api docs to the existing documentation. But doing this under the sidebars.js file {
type: 'link',
label: 'REST API Reference',
href: '/rest-api-reference/',
}, works fine, which answers my question too as I can just add articles around this. |
Show examples with:
The text was updated successfully, but these errors were encountered: