Markdown gets not correctly rendered in API.md

[a1300]

• Version: v0.29.3
• Platform:
• Subsystem:

Type: Documentation Bug

Severity: Low

Description: A | symbol in a markdown table cell messes the markdown up

This markdown

Gets rendered as

Affects

• dialProtocol https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#dialprotocol
• peerStore.addressBook.get https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#peerstoreaddressbookget
• peerStore.addressBook.getMultiaddrsForPeer https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#peerstoreaddressbookgetmultiaddrsforpeer

[vasco-santos]

This is super weird. On vscode Markdown preview it shows up correctly. Did you understand the issue behind this?

[a1300]

This is seems like a Github/Gist Markdown issue. I created an issue on the unofficial github bug repository https://github.com/isaacs/github/issues/1875

According to submitting-bug-reports-for-github-com I also will send a Bug report

[a1300]

Bug report on github.community https://github.community/t/bug-markdown-inline-code-blocks-with-pipe-symbols-within-a-table-cell-destroy-the-table/145896

[vasco-santos]

Thanks for looking into this @a1300 ❤️

[wemeetagain]

API.md no longer has tables