Github Task Lists

[jhollingworth]

Add support for Github Task Lists under the gfm flag.

Changes to API

• list(string body, boolean ordered, boolean taskList)
• listitem(string text, [boolean checked]).

checked is defined when you have a list item which starts with [ ] or
[x].If defined its a boolean depending on whether the x is
present. When checked is defined we add a input type type checkbox to
the list item and add the class task-list-item-checkbox.

taskList is true if a list has any list items where checked is
defined. When true we add the class task-list to the list.

Resolves#107

[styfle]

@jhollingworth
Very cool. Hopefully this gets merged.
However this project doesn't seem very active anymore.
You might want to checkout markdown-it

[chjj]

I had an implementation of this that I reverted because I was originally completely against further GFM extras. I thought I had lost it when my laptop bricked, but I realized it wasn't on a separate unpushed branch. It's in the git history: #107

I'll compare these two.

[jhollingworth]

do you mean 26cef98 and a5e39a6? The one issue I saw with yours was it does not support the scenario where a list has items that are not checkboxes.

• Foo
• Bar
• Baz

Also, have your view changed on adding GFM extras or do you not want to merge this?

[ghost]

According to GFM docs [v] is a valid way to indicate a task is complete as well.

[ghost]

@jhollingworth thanks for starting with the lexer as that fits my use case.

[felixSchl]

What's happening with this?

[cdaguerre]

Will this make it to core? Any ETA?

[dvcrn]

Using this code in a app right now and seems to work good. Would love to see this getting merged back

[msto]

Any chance of this getting pulled in in the near future? Would love to have checkboxes available in ipython notebooks, and they're waiting on it to be implemented here.

ipython/ipython#8402
ipython/ipython#6288

[noerw]

would love to see this too

[Sohalt]

Any updates on this?
This would make integration of checklists for https://github.com/wekan/wekan much easier.

[ousamabenyounes]

Checklist feature is an important feature for wekan project...
So merging this pull request would help developpers to finish this other pull request wekan/wekan#298 (comment) and be sure they won't use another alternative...Hope to see this on wekan project soon...

[chrisdias]

Hi! Any chance this will get merged? We would like top pick up this fix for VS Code.

[dvcrn]

This project is definitely dead. I merged this in a own fork and use that for markright

[ZackWard]

@matt-@parleur Thank you for maintaining this project. I would love to +1 this PR.

[odama626]

I too am hoping this will be merged, in the meantime I am using a simple wrapper function to achieve this. Maybe this will help someone until then.

function markdownFormatter(text) {
var a = marked(text, {break: true});
a = a.replace(/<a/g, '<a target="_blank"')
.replace(/<li>\[\s\]/g, '<li class="check-box"><input onclick="return false" type="checkbox">')
.replace(/<li>\[x\]/g, '<li class="check-box"><input checked onclick="return false" type="checkbox">');
return a;
}

[jbddc]

+1

[stanleykylee]

@chjj@matt- any updates on whether or not this will be merged as it is approved now?

[heaven00]

would love to have this! 👍

[styfle]

To reference myself above:

Many users have migrated from marked to markdown-it due to inactivity and failure to merge the 163 pending PRs. This PR in particular has at least 30 people interested but it's mostly too late.

@chrisdias@richarddavenport
VS Code switched to markdown-it and now has plugin to support Task Lists
https://github.com/mjbvz/vscode-markdown-checkboxes

[samiraguiar]

Thank you, @styfle, I had missed your comment. Now I can finally unsubscribe from this thread.

[Xaekai]

I guess I'm going to give up too and switch to markdown-it

The negligence of the maintainers here is unacceptable. I've waited over a year.

[joshbruce]

See #956

Focusing on CommonMark and GFM specifications, without extensions (task lists in GFM are an extension not part of core). Cleaning house and assessing the damage. If this gets implemented it will probably be through extension via open/closed.

Thanks, and apologies for the inconvenience.

[joshbruce]

Reopening as things have changed a bit. We are looking to support GFM, which is only CommonMark with extensions. We have two test beds at present one for CommonMark the other for GFM. There are two failing tests (both examples) in the task list test suite.

Can we verify this solution causes those to pass?

[styfle]

This file was moved to USING_PRO.md. and is causing merge conflicts.

[huruji]

thanks for the creator and maintainers' job, I hope I can see checkbox in my project，thank you

[styfle]

@jhollingworth Are you still interested in working on this PR?

[joshbruce]

Going to go ahead and close as overcome by events. If you would like to continue working toward this goal:

1. Read Defibrillator challenge #1216
2. Submit a PR that solves GFM example 272 and 273 in the gfm/gfm-spec.js file.

[30Wedge]

Ping; I want to show that I'm still interested in this PR.
Jupyter uses marked, and I'd like to use gfm task lists in my notebook.

[joshbruce]

@30Wedge: What version of Marked are you using?

0.4.0 should include task lists if I'm remembering #1250 properly.

[30Wedge]

Looks like they were using 0.3.0
Thanks for responding so quickly!