Redocly / Redocly/create-openapi-repo
[Question] Editor/plugin with support for embedding external markdown
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 695
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
"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?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No project file, test, or entry point is named. Review the openapi-repo workflow and the reported 42crunch.vscode-openapi crash with external Markdown references; done means documenting a preferred workflow and toolset that avoids copy/pasting and commenting out the API definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, vscode
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100