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

docusaurus-plugin-typedoc causes fatal error on Windows #245

Closed
mysticatea opened this issue Jul 20, 2021 · 2 comments
Closed

docusaurus-plugin-typedoc causes fatal error on Windows #245

mysticatea opened this issue Jul 20, 2021 · 2 comments

Comments

@mysticatea
Copy link

Hello.

First, thank you for the useful plugins.

After I upgraded docusaurus-plugin-typedoc, it started to fail on Windows.

Error while parsing Markdown frontmatter.
This can happen if you use special characters in frontmatter values (try using double quotes around that value).
Can't process doc metadatas for doc at path "C:\Users\***\index.md" in version "current"
Loading of version failed for version "current"
YAMLException: unknown escape sequence at line 4, column 14:
    slug: "/util\foo"
                 ^

It looks that docusaurus-plugin-typedoc uses Windows paths as-is for the slug.

https://github.com/tgreyuk/typedoc-plugin-markdown/blob/0047faf1d3e2ec91752cef0603f2838ce1e70be9/packages/docusaurus-plugin-typedoc/src/front-matter.ts#L56

@tgreyuk
Copy link
Member

tgreyuk commented Jul 20, 2021

thanks - fix in docusaurus-plugin-typedoc@0.15.3

@mysticatea
Copy link
Author

I have confirmed that's fixed. Thank you!

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