free-programming-books icon indicating copy to clipboard operation
free-programming-books copied to clipboard

Mark up look strange on the site when using pipes `|`

Open computamike opened this issue 5 years ago • 10 comments

It seems that the | in the link breaks the rendering C#

Renders correctly when viewing the page within GitHub editing tools, but renders incorrectly on the GH Pages site.

computamike avatar Nov 20 '20 23:11 computamike

not surprising I guess. Want to fix it?

eshellman avatar Nov 21 '20 00:11 eshellman

hi @eshellman - I'm looking into it now...

computamike avatar Nov 21 '20 02:11 computamike

For more information - I have developed a linter plugin for this issue, just trying to figure out how to contribute it.

https://github.com/computamike/remark-link-escape

Do I close this issue, or is that something that the team needs to do?

computamike avatar Nov 23 '20 02:11 computamike

Let's leave it open; hopefully it will be addressed together with #5031

eshellman avatar Nov 23 '20 14:11 eshellman

Hi team

Although the nice @computamike's plugin was added as dependency in v2.2.0, this improvement was reverted in 2.3.0 (2020 Dec)

https://github.com/vhf/free-programming-books-lint/compare/v2.2.0...v2.3.0

@vhf CI action is now using last released version (v3.0.0) with last alphabetize requested features #5031 but not with vhf/free-programming-books-lint#12

CI logs: https://github.com/EbookFoundation/free-programming-books/runs/3195091515?check_suite_focus=true#step:4:8 (see install lint step)

I don't know what is their status because I'm newbie, but it would be a nice point to reintegrate again before it rots into oblivion, I thought @eshellman 🤗

/labelthis: resummit pr

davorpa avatar Jul 31 '21 19:07 davorpa

Took me awhile to find the relevant page: https://ebookfoundation.github.io/free-programming-books/casts/free-podcasts-screencasts-en.html

Appears to be rendering fine now image

charlottetan avatar Oct 03 '21 00:10 charlottetan

Took me awhile to find the relevant page: https://ebookfoundation.github.io/free-programming-books/casts/free-podcasts-screencasts-en.html

Appears to be rendering fine now

We know it. See the fix #5177. The vertical bar is escaped

davorpa avatar Oct 03 '21 01:10 davorpa

Oh nice thanks! What is the remaining work on this issue? Did you want to close this issue?

charlottetan avatar Oct 03 '21 01:10 charlottetan

It also happens in Arabic courses file #6715

Environment Screenshot
Github File Preview :+1: image
GitHub Pages :-1: image image

Is wellknown that pipes is the table markdown token. Seems that Kramdown don't deal well with it

davorpa avatar Feb 11 '22 07:02 davorpa

Needs linter replug in to definitelly solve it. See https://github.com/EbookFoundation/free-programming-books/issues/5176#issuecomment-890391432

Notified to kramdown engine at https://github.com/kramdown/parser-gfm/issues/35

davorpa avatar Feb 14 '22 18:02 davorpa