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

escapeString in typedoc-plugin-markdown doesn't escape leading quotes #228

Closed
0x31 opened this issue May 25, 2021 · 1 comment
Closed

escapeString in typedoc-plugin-markdown doesn't escape leading quotes #228

0x31 opened this issue May 25, 2021 · 1 comment

Comments

@0x31
Copy link

0x31 commented May 25, 2021

https://github.com/tgreyuk/typedoc-plugin-markdown/blob/e6046b0aa1779fb316fa2448457aa468569c38e5/packages/typedoc-plugin-markdown/src/utils/front-matter.ts#L47

By checking that the quote doesn't already follow an escape, it misses double quotes at the start of the string.

In docusaurus-plugin-typedoc, this can cause issues with the sidebar label:

sidebar_label: ""library-name\""

which causes the error

YAMLException: can not read a block mapping entry; a multiline key may not be an implicit key at line 5, column 16:
    custom_edit_url: null
@tgreyuk
Copy link
Member

tgreyuk commented May 26, 2021

thanks - fix in 3.8.2

@tgreyuk tgreyuk closed this as completed May 27, 2021
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