Github Task Lists #587

jhollingworth · 2015-05-06T07:49:58Z

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

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 markedjs#107

styfle · 2015-05-08T00:39:53Z

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

chjj · 2015-05-08T00:57:10Z

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 · 2015-05-08T05:18:23Z

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 · 2015-05-15T22:46:39Z

lib/marked.js

@@ -27,6 +27,7 @@ var block = {
 text: /^[^\n]+/
 };

+block.checkbox = /^\[([ x])\] +/;


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

ghost · 2015-05-15T22:48:59Z

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

felixSchl · 2015-07-24T10:31:08Z

What's happening with this?

cdaguerre · 2015-10-31T09:01:27Z

Will this make it to core? Any ETA?

dvcrn · 2015-11-11T05:52:42Z

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

Permalink are now created for notes. GFM TaksLists are supported now. :) Thanks to [this](markedjs/marked#587) PR.

msto · 2015-12-19T03:41:23Z

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 · 2016-02-09T14:14:03Z

would love to see this too

Sohalt · 2016-02-18T23:39:17Z

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

ousamabenyounes · 2016-02-19T07:22:42Z

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 · 2016-04-20T20:17:29Z

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

dvcrn · 2016-04-20T23:34:50Z

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

ZackWard · 2016-07-09T14:52:32Z

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

styfle · 2017-08-14T16:18:05Z

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 · 2017-08-15T03:23:25Z

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

Xaekai · 2017-08-21T22:23:31Z

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 · 2017-12-06T01:43:01Z

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 · 2018-04-13T13:33:11Z

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 · 2018-04-13T13:42:08Z

README.md

@@ -211,7 +212,8 @@ This code will output the following HTML:
 - codespan(*string* code)
 - br()
 - del(*string* text)
- link(*string* href, *string* title, *string* text)
+- link(*string* href, *string* title, *string* text, [*boolean* checked]).
+ - `checked` only defined when `gfm` is `true` and there is a check box at the start of the list item (e.g. `* [ ] foo`).


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

huruji · 2018-04-17T19:00:19Z

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

styfle · 2018-04-17T21:11:14Z

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

joshbruce · 2018-04-18T14:26:32Z

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

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

30Wedge · 2018-06-13T13:18:32Z

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 · 2018-06-13T13:35:23Z

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

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

30Wedge · 2018-06-13T17:41:49Z

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

jhollingworth mentioned this pull request May 6, 2015

To do lists #107

Closed

jdfreder mentioned this pull request May 6, 2015

Modified markdown rendering to include GFM-style checkboxes ipython/ipython#8402

Closed

jhollingworth force-pushed the master branch from b0a4fed to 91a1f7a Compare May 8, 2015 07:03

Merge github.com:chjj/marked

c0cf004

ghost reviewed May 15, 2015
View reviewed changes

at15 mentioned this pull request Aug 4, 2015

Support todo list at15/doc-viewer#17

Closed

2 tasks

dvcrn mentioned this pull request Nov 11, 2015

Task list checkboxes aren't rendered dvcrn/markright#23

Closed

3 tasks

levlaz pushed a commit to levlaz/braindump that referenced this pull request Nov 25, 2015

View Single Notes, and Task Lists

4742f38

Permalink are now created for notes. GFM TaksLists are supported now. :) Thanks to [this](markedjs/marked#587) PR.

levlaz mentioned this pull request Nov 25, 2015

Ux improvements levlaz/braindump#12

Merged

gkoberger mentioned this pull request Jan 11, 2016

Feature request: Checkboxes and radioboxes #263

Closed

hsduk mentioned this pull request Jan 16, 2016

Support gfm checkboxes perak/markdown#7

Open

Sohalt mentioned this pull request Feb 19, 2016

Checklist wekan/wekan#298

Closed

clehner mentioned this pull request Apr 24, 2016

Github Task Lists ssbc/marked#2

Merged

matrixbot mentioned this pull request Jul 20, 2016

Support GFM checkboxes (disabled) for completeness element-hq/element-web#1832

Closed

karllhughes mentioned this pull request Jul 16, 2017

Support for checkboxes conclurer/markdown-to-html-pipe#7

Closed

2 tasks

QingWei-Li mentioned this pull request Jul 18, 2017

The "check box" style issue ! docsifyjs/docsify#215

Closed

joshbruce closed this Dec 6, 2017

styfle mentioned this pull request Dec 21, 2017

javascript: URLs not filtered out properly schn4ck/schnack#49

Closed

Jocs mentioned this pull request Apr 13, 2018

Question: Why embed marked instead of including as a dependency? marktext/marktext#141

Closed

joshbruce reopened this Apr 13, 2018

styfle reviewed Apr 13, 2018

View reviewed changes

styfle requested review from UziTech and joshbruce April 17, 2018 21:09

styfle mentioned this pull request Apr 18, 2018

security: finish fixing unsafe heading regex #1226

Closed

joshbruce closed this Apr 18, 2018

tomtheisen mentioned this pull request May 8, 2018

GFM compliance for tasks lists #1250

Merged

5 tasks

ekmixon mentioned this pull request Dec 1, 2023

[Snyk] Fix for 1 vulnerabilities ekmixon/marked#130

Open

ekmixon mentioned this pull request May 13, 2024

[Snyk] Fix for 2 vulnerabilities ekmixon/marked#135

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Github Task Lists #587

Github Task Lists #587

jhollingworth commented May 6, 2015

styfle commented May 8, 2015

chjj commented May 8, 2015

jhollingworth commented May 8, 2015

ghost May 15, 2015

ghost commented May 15, 2015

felixSchl commented Jul 24, 2015

cdaguerre commented Oct 31, 2015

dvcrn commented Nov 11, 2015

msto commented Dec 19, 2015

noerw commented Feb 9, 2016

Sohalt commented Feb 18, 2016

ousamabenyounes commented Feb 19, 2016

chrisdias commented Apr 20, 2016

dvcrn commented Apr 20, 2016

ZackWard commented Jul 9, 2016

styfle commented Aug 14, 2017

samiraguiar commented Aug 15, 2017

Xaekai commented Aug 21, 2017

joshbruce commented Dec 6, 2017 •

edited

Loading

joshbruce commented Apr 13, 2018

styfle Apr 13, 2018

huruji commented Apr 17, 2018 •

edited

Loading

styfle commented Apr 17, 2018

joshbruce commented Apr 18, 2018

30Wedge commented Jun 13, 2018

joshbruce commented Jun 13, 2018

30Wedge commented Jun 13, 2018

Github Task Lists #587

Github Task Lists #587

Conversation

jhollingworth commented May 6, 2015

styfle commented May 8, 2015

chjj commented May 8, 2015

jhollingworth commented May 8, 2015

ghost May 15, 2015

Choose a reason for hiding this comment

ghost commented May 15, 2015

felixSchl commented Jul 24, 2015

cdaguerre commented Oct 31, 2015

dvcrn commented Nov 11, 2015

msto commented Dec 19, 2015

noerw commented Feb 9, 2016

Sohalt commented Feb 18, 2016

ousamabenyounes commented Feb 19, 2016

chrisdias commented Apr 20, 2016

dvcrn commented Apr 20, 2016

ZackWard commented Jul 9, 2016

styfle commented Aug 14, 2017

samiraguiar commented Aug 15, 2017

Xaekai commented Aug 21, 2017

joshbruce commented Dec 6, 2017 • edited Loading

joshbruce commented Apr 13, 2018

styfle Apr 13, 2018

Choose a reason for hiding this comment

huruji commented Apr 17, 2018 • edited Loading

styfle commented Apr 17, 2018

joshbruce commented Apr 18, 2018

30Wedge commented Jun 13, 2018

joshbruce commented Jun 13, 2018

30Wedge commented Jun 13, 2018

joshbruce commented Dec 6, 2017 •

edited

Loading

huruji commented Apr 17, 2018 •

edited

Loading