thephpleague / thephpleague/commonmark

TaskList: Listener to update markdown

Open
#511 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion do not close enhancement feedback wanted
Dominant language
PHP
Stars
3k
Forks
217
Avg merge
1d 13h
Merged PRs (30d)
2

Description

I was wondering if commonmark provided example for TaskListExtension how to:

  1. add javascript listener on click of task item
  2. modify markdown to handle the ticked state of the task item

this would make implementing full task list functionality easier for downstream projects.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the TaskListExtension documentation linked in the issue and determine where an example for the requested browser behavior belongs. Document a JavaScript click listener for task items and how the ticked state is reflected in markdown; done means downstream projects can follow the example to implement full task-list functionality.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, php
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.