Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[docs] Tables which has a pipe in a code are broken

See original GitHub issue

SSIA. The | in the code (`) is recognized as a table separator.

code:

| Name                                    | Type                              | Description                                                                                                                                                         |
| --------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [iosClientId][g-creds]                  | `string | undefined`              | The iOS client id registered with Google for use in the Expo client app.                                                                                            |

capture:

page: https://docs.expo.io/versions/v39.0.0/sdk/google/

This was caused by #10177 . MDX v1 is GFM compliant, and GFM has same problem.

Name	Type	Description
[iosClientId][g-creds]	`string	undefined`

this can be solved with escaping the pipe in GFM.

| Name                                    | Type                              | Description                                                                                                                                                         |
| --------------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [iosClientId][g-creds]                  | `string \| undefined`              | The iOS client id registered with Google for use in the Expo client app.                                                                                            |

Name	Type	Description
[iosClientId][g-creds]	`string \| undefined`	The iOS client id registered with Google for use in the Expo client app.

but, in the MDX v1.6.18, \ is remaining.

This is MDX’s issue. https://github.com/mdx-js/mdx/issues/1285

workaround

revert #10177 😢

Issue Analytics

State:
Created 3 years ago
Comments:5 (4 by maintainers)

Top GitHub Comments

1reaction

idecommented, Oct 5, 2020

I agree the second option is better. The issue is non-obvious and needs to be communicated instead of hidden behind a different unicode character since this is text that people type. The divisor character would make sense to me if it were autogenerated on each build and never typed by people, but otherwise no one is going to know they need to type it. Also it presumably breaks copy/pasting from the docs.

0reactions

wooormcommented, Oct 7, 2020

It’s not remark internals. It’s MDX internals