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

Pipe-escape \| inside table is broken (also pipe-symbol in code-block) #592

Closed
adroste opened this issue Jul 29, 2018 · 5 comments
Closed

Comments

@adroste
Copy link

adroste commented Jul 29, 2018

If i have a table with an escaped pipe-symbol like the following one:

| h1         | h2  |
| ---        | --- |
| abc \| def | xyz |

it is rendered like:

screen shot 2018-07-29 at 19 01 08

because the escape-sequence is not recognized and/or handled properly.

Replacing \| with | is my workaround atm.

@ddivecs
Copy link

ddivecs commented Aug 15, 2018

To add onto this, there is currently no way to put a codeblock with a pipe in a table

|param|Type|Description|
|-----|-----|-----|
|foo|`string|function`|takes a string or function|

renders as
image

and

|param|Type|Description|
|-----|-----|-----|
|foo|`string|function`|takes a string or function|

renders as
image

currently, id have to write

`string`|`function`

which is not quite what i want to write, since im trying to document a type in typescript and the whole thing is a single type.

@adroste
Copy link
Author

adroste commented Aug 15, 2018

@ddivecs I ran into the same problem. In fact i am having so many problems - i already reported 2 bugs - that i restructured my docs into the original source and the docsify source. I generate the docsify source with the help of a script i wrote to fix/workaround a bunch of bugs/errors (like this one).

@adroste adroste changed the title Pipe-escape \| inside table is broken Pipe-escape \| inside table is broken (also pipe-symbol in code-block) Aug 15, 2018
@ddivecs
Copy link

ddivecs commented Aug 16, 2018

i ended up just inlining an HTML table because my table got a little more complex (i needed a large code block using triple back ticks instead of just an inline codeblock) but i still believe that in the simple case where you just want a vertical bar in a table, there should be an easy way to escape a vertical bar.

@kirbdee
Copy link

kirbdee commented Aug 23, 2018

Looks like marked resolved this with 0.3.19. Could we just rebuild the scripts for CDN? Optionally you could also build docsify locally

@QingWei-Li
Copy link
Member

QingWei-Li commented Oct 31, 2018

4.8.0 is released for upgrade marked version.

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

4 participants