interactivethings/catalog

HTML comments in Markdown files break the page

Opened this issue · 0 comments

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.