SSWConsulting / SSWConsulting/SSW.Rules

Netlify CMS - Create "good" wrapper custom markdown element

Open
#663 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 "good" wrapper to a rule by inserting this custom markdown:

::: good
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 good wrapper
  • Add the custom widget to the markdown editor

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

AB#63651

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

First check the dependency on #654 and review how the markdown editor currently registers custom widgets. Implement the two checklist items so a button inserts the existing ::: good wrapper, then verify the widget appears in the editor and produces the expected markdown.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.