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

[Question] Editor/plugin with support for embedding external markdown #71

Open
austpaul opened this issue Mar 15, 2021 · 1 comment
Open

Comments

@austpaul
Copy link

"Write it using your favorite text-editor or IDE (we love VSCode)."

Which plugin do you use when editing an openAPI repo? For large project and multiple contributions, externalizing the markdown makes a lot of sense.
I'm currently using the OpenAPI (Swagger) Editor (42crunch.vscode-openapi) with the Redoc rendering setting. This crashes when adding references to external markdown files.

Do you have any preferred workflow and toolset that doesn't involve a lot of copy/pasting and commenting out the API definition while working with the openapi-repo structure?

@mimkorn
Copy link

mimkorn commented Mar 16, 2021

I was wondering about the same. I was using Stoplight Studio, cause that's quite amazing and free, but openapi-cli does some opinionated proprietary splitting which other tools do not consume.

However, you can do with VS Code + these two extensions:
https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
https://marketplace.visualstudio.com/items?itemName=proohit.openapi-snippets

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

No branches or pull requests

2 participants