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

HTML comments in Markdown files break the page #519

Open
TyMick opened this issue Dec 4, 2020 · 0 comments
Open

HTML comments in Markdown files break the page #519

TyMick opened this issue Dec 4, 2020 · 0 comments

Comments

@TyMick
Copy link

TyMick commented Dec 4, 2020

Not a super important feature. I was just wanting to add a comment in a Markdown file to make sure developers know not to change that file itself.

Here's the entirety of that file:

For the next major version of Styled UI, the SimpleToast component has been rebuilt to use Styled System primitives.

You can opt in to the new API now by importing `{ SimpleToast } from '@faithlife/styled-ui/v6'`. When v6 is released, the `/v6` entrypoint will continue to be supported with a deprecation warning until v7 is released.

<!-- This documentation is automatically generated from jsdoc comments. -->

```react
noSource: true
---
<DocgenTable component={SimpleToast} />
```

When I got to that page, my browser shows me two errors:

  • TypeError: _html.join is not a function
  • Unhandled Rejection (TypeError): _html.join is not a function

Here are the full error pages if you'd like to take a look.

I'm running Catalog 3.6.0, by the way. In case it helps, here are our catalog/docgen-table.jsx, catalog/index.js, and catalog/index.html. And I'm seeing these errors on macOS in Firefox, Chromium, and Safari.

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

1 participant