GFM support

TODO

task list gfm task list / checkbox support #63 Add more specs, strikethrough / task list improvements #65
table Table support #72
strikethrough GFM: Strikethrough support #62 Add more specs, strikethrough / task list improvements #65
emoji Add GitHub emoji support #61
footnotes Footnotes implementation #78
table edge cases
autolink edge cases #82

Will this include dimensions for images?
Usually done via:

![](https://imageurl.com =500x500)

Until this is added I do have support for gfm in my octokit.cr shard. The downside is that it has to make http requests to github's api, but it works.

Smart, but the best solution is to use javascript markdown library for now 🤣

I really hope that GFM is added soon to markd. In the meantime, I created a cr-cmark-gfm, a shard that binds to the official GFM C library. You can render to multiple formats, create custom nodes, renderers, etc. If you need full support of GFM in crystal give it a try. PRs welcome!

Emoji does not appear to really be part of cmark-gfm, FWIW per: github/cmark-gfm#75
Guess that leaves tables and task-lists.

Tables are probably the most commonly used feature of GFM. They're dearly missed in markd.

I'm currently focused on my work and no more time on Crystal language, as I mentioned before I would like to donate the project to crystal officials.

Sorry about this 🥲

Just to be clear, my comment was not a request for you to take care of this.

Why don't you start a discussion about transferring ownership of the project? I think https://forum.crystal-lang.org/ would be a good place to find a solution for a community-supported new home.

I'm sure we'll find a good way to move forward. markd is an important piece of Crystal's ecosystem. Thank you very much for creating it and taking care of it!

I've started working on this here. So far I've done strikethrough, hope to get to the rest soon.

after use markd several days, I find the table feature is still missing ...

That is correct. Tables are complex and will require a lot of work to fit into the existing architecture (which itself should probably be updated).

Just for guys want table feature with markd, i workaround this use a trick.

e.g. i create a table like this:

…………………………………………………………………………  Ruby   ……………………………………………………   Crystal

------------

Enumerable#each  ………………………… 返回 self ………………………………………………………… 返回 nil

Array#fetch  …………………………  接受一个参数的形式 …… 需提供第二参数或 `block` 指定默认值

alias ………………………………………………    创建方法的别名 ………… 为（通常比较复杂的）类型定义一个别名

-------------

the Char between the column is ……, it's a full width character, I can input it use keyboard ^ when enable Chinese input method(fcitx) in Linux, it will be replace with "\u{3000}", which is a Chinese full width Space, it can show a really space even in the

tag.

following is the replacement code:

text = text.gsub(/……(?=……| )/, "‏　").gsub("…", "")
Markd.to_html(text)

Following is the rendered result use markd

Not pefect, but useable, and write quickly too.

I am thinking, maybe we can use this trick to add a poor person's version of the table?

Most of the time you can use HTML tables as a workaround.

Go for it!

How about #57 ? should we add back to markd from markterm?

I opened an issue to talk about that, I will try to do a PR bringing two renderers from markterm into marks later today

…

On Sat, Mar 8, 2025, 6:48 AM Billy.Zheng ***@***.***> wrote: How about #57 <#57> ? should we add back to markd from markterm? — Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAAMK6EH6BNYVVRZHNPRL32TK4FPAVCNFSM6AAAAABWN7TKFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGE3DSOBXGI> . You are receiving this because you commented.Message ID: ***@***.***> [image: zw963]*zw963* left a comment (icyleaf/markd#4) <#4 (comment)> How about #57 <#57> ? should we add back to markd from markterm? — Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAAMK6EH6BNYVVRZHNPRL32TK4FPAVCNFSM6AAAAABWN7TKFOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGE3DSOBXGI> . You are receiving this because you commented.Message ID: ***@***.***>

I opened an issue to talk about that, I will try to do a PR bringing two
renderers from markterm into marks later today
…

Hi, I am not use this feature, i mention it just because there is a open issue about it.

Consider talk about it at first with maintainer before you do it anyway.

Footnotes is more complicated than it seems but I am making progress (about 30% there I guess), probably will get it working in another week.

WIP PR here

I opened an issue to talk about that, I will try to do a PR bringing two
renderers from markterm into marks later today
…

Hi, I am not use this feature, i mention it just because there is a open issue about it.

Consider talk about it at first with maintainer before you do it anyway.

Sorry, In fact, It may be useful for me when convert/fix the users (markdown)input in the comment into valid markdown, anyway, thanks

Initial very limited support for footnotes:

#78

I still need to do one or two PRs more, but didn't want to make this one bigger and harder to review.

Also, I think I already fixed all the "table edge cases" in a previous PR so it can be checked in the description.

I am stumped about how to make the footnote definition work as a container in #78

Surely I am missing the exact combination of Match::Container ans parser.advance or whatever.

This is needed because the content of the definition are basically to be parsed as part of the document, they may include blocks (code blocks, blockquotes, etc)

Sorry but at the end of my rope with that, so unless someone gives a hand it's probably not going to progress further.

Why not make a release? There are a lot of features implemented, there is no need to have full GFM support to do it.

I've been meaning to take a look at your PR to see if I could help get it over the line, life stuff has gotten in the way recently though. Should have time soon.

@nobodywasishere

@nobodywasishere no worries, I suspect tables is a much more interesting thing for users than footnotes, so a release without that PR should still be nice :-)

I have pushed changes in #78 that complete the footnote implementation, which was the only thing left for GFM support AFAIK?

@ralsina

@ralsina What are the remaining pending gfm tests with that PR done?

There are 5 pending tests in total, 4 of them gfm related:

1 in gfm regressions:

Issue commonmark#526 - unescaped ( in link title

```````````````````````````````` example pending
[link](url ((title))
.
<p>[link](url ((title))</p>

2 in gfm-spec:


foo <!-- this is a --
comment - with hyphens -->
.
<p>foo <!-- this is a --
comment - with hyphens --></p>

foo <!--> foo -->

foo <!---> foo -->
.
<p>foo <!--> foo --&gt;</p>
<p>foo <!---> foo --&gt;</p>

1 in gfm-extensions (which I think is not a bug but a spec ambiguity)

mmmmailto:scyther@pokemon.com
.
<p>mmmmailto:<a href="mailto:scyther@pokemon.com">scyther@pokemon.com</a></p>

Navigation Menu

Repository navigation

GFM support #4

TODO

12 remaining items

1 in gfm regressions:

2 in gfm-spec:

1 in gfm-extensions (which I think is not a bug but a spec ambiguity)

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

GFM support #4

Description

TODO

Activity

drum445 commented on Mar 12, 2019

watzon commented on Jun 20, 2019

icyleaf commented on Jun 25, 2019

amauryt commented on Oct 14, 2019

nanobowers commented on Jul 11, 2021

straight-shoota commented on Mar 15, 2022

icyleaf commented on Mar 21, 2022

straight-shoota commented on Mar 21, 2022

nobodywasishere commented on Mar 27, 2024

zw963 commented on Feb 4, 2025

nobodywasishere commented on Feb 4, 2025

zw963 commented on Feb 7, 2025

straight-shoota commented on Feb 7, 2025

12 remaining items

nobodywasishere commented on Mar 7, 2025

zw963 commented on Mar 8, 2025

ralsina commented on Mar 8, 2025

zw963 commented on Mar 9, 2025

ralsina commented on Mar 9, 2025

zw963 commented on Mar 9, 2025

ralsina commented on Mar 13, 2025

ralsina commented on Mar 13, 2025

ralsina commented on Mar 18, 2025

ralsina commented on Apr 14, 2025

nobodywasishere commented on Apr 14, 2025

ralsina commented on Apr 14, 2025

ralsina commented on Feb 15, 2026

nobodywasishere commented on Feb 23, 2026

ralsina commented on Feb 23, 2026

1 in gfm regressions:

2 in gfm-spec:

1 in gfm-extensions (which I think is not a bug but a spec ambiguity)

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions