SSWConsulting / SSWConsulting/SSW.Rules

Netlify CMS - Create "info" box custom markdown element

Open
#667 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 an "info" box to a rule by inserting this custom markdown:

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

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

AB#63655

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

Resolve #654 first, then review the Netlify CMS markdown editor and its custom widget configuration. Implement an info-box widget that inserts the shown ::: info syntax and add it to the markdown editor; done means users can insert an info box through the editor instead of typing the markup.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.