SSWConsulting / SSWConsulting/SSW.Rules
Archived package - gatsby-custom-md
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,
The greybox in SSW Rules currently uses the gatsby-custom-md package to render the Greybox component where needed. However, this package has been archived by the owner, and hasn't been updated in 2 years.

Figure: gatsby-custom-md package archived and not updated - https://github.com/akzhy/gatsby-custom-md
This package not being updated is also preventing us from updating the rehype-react package, as the change made in its latest version will break the deprecated gatsby-custom-md package.
The other custom markdown elements such as info boxes, China boxes and CodeAuditor boxes all replace their markdown syntax with a <div> of a particular class. Perhaps this approach can be used to render the greybox instead of the current setup.
See https://github.com/SSWConsulting/SSW.Rules/blob/main/src/cms/previewTemplate.js#L18
There is also a plugin called gatsby-plugin-mdx which allows users to write components in markdown using MDX. This may be a potential solution, as well as a way to add more customisation to Rules and change the way custom markdown elements are used in the future.
See https://www.gatsbyjs.com/plugins/gatsby-plugin-mdx/
- Change the greybox to render without needing
gatsby-custom-md - Remove
gatsby-custom-mdfrom SSW Rules - Update
rehype-react
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at src/cms/previewTemplate.js around line 18 and compare how the other custom markdown elements render their divs. Determine how the greybox can render without gatsby-custom-md, then verify that the package is removed, rehype-react can be updated, and the greybox still renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100