docusaurus-openapi-docs
docusaurus-openapi-docs copied to clipboard
Fenced code blocks started with `~~~` are incorrectly cleaned in v3
Describe the bug
Markdown supports initiating fenced code blocks with ~~~, https://www.markdownguide.org/extended-syntax/#fenced-code-blocks, but it is incorrectly cleaned.
Expected behavior
~~~
{
}
~~~
Current behavior
~~~
\{
\}
~~~
Possible solution
Modify the cleaning regexp: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/packages/docusaurus-plugin-openapi-docs/src/markdown/utils.ts#L65
Steps to reproduce
- Add a code block using
~~~to the description of a field in OpenAPI specification containing a JSON object. - Generate markdown from OpenAPI specification with
docusaurus gen-api-docs all. - See curly braces prefixed with the backslash in the generated files.
Screenshots
Code block initiated with ~~~:
Code block initiated with ``` works as expected:
Context
Your Environment
- Version used: 3.0.1
- Environment name and version (e.g. Chrome 59, node.js 5.4, python 3.7.3): node.js 20
- Operating System and version (desktop or mobile): desktop
- Link to your project:
Hi @Ugzuzg, thanks for reporting the issue. The fix seems straightforward but can you provide steps to reproduce so I can be certain I'm addressing your issue? Are you defining these code blocks/fences in normal doc files or embedding them inside your OpenAPI spec summary/description?
@sserrata, edited the description with more details.