SSWConsulting / SSWConsulting/SSW.Rules.Content

🐛 Lists will break a greybox because of indentation

Open
#8,969 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
62
Forks
196
Avg merge
1d 4h
Merged PRs (30d)
112

Description

Cc: @Tanya-Leahy @adamcogan @bradystroud @leahy268

Hi team,

I've seen a couple of these in the past and @Tanya-Leahy found 5+ more (all manually fixed by me on https://github.com/SSWConsulting/SSW.Rules.Content/pull/8968 and https://github.com/SSWConsulting/SSW.Rules.Content/pull/8970)

When you have a list inside a greybox (same on info box and email templates), the code somehow adds an identation to the closing ::: tag which makes it render wrongly:

  • 1. Please investigate and fix

Image

Figure: The identation in Markdown (not done by the editor)

Image

Figure: Broken greybox in the live page

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 comparing the manually fixed content in pull requests 8968 and 8970 with the affected list-inside-greybox examples. Trace where the closing ::: indentation is introduced for greyboxes, info boxes, and email templates. Done means these constructs render correctly without manually adjusting the Markdown indentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.