SSWConsulting / SSWConsulting/SSW.Rules

Netlify CMS - Create "todo" box custom markdown element

Open
#670 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

@pierssinclairssw @bradystroud @adamcogan

Hi,

As discussed in https://github.com/SSWConsulting/SSW.Rules/issues/615
Currently users can add a "todo" box to a rule by inserting this custom markdown:

::: todo
Content
:::

To make the process easier for users, we want to make a button that inserts this for us.

  • Create a custom widget for the todo box
  • Add the custom widget to the markdown editor

Note: This issue should wait until #654 is resolved.

AB#63658

Contributor guide

No contributing guide indexed for this repository

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 by reviewing the resolution of issue #654, then locate the existing Netlify CMS custom widgets and markdown editor configuration. Done means the editor offers a todo-box control that inserts the documented ::: todo syntax and both checklist items are complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.