Skip to content

Conversation

@simurai
Copy link
Contributor

@simurai simurai commented Sep 23, 2022

What are you trying to accomplish?

This fixes https://github.com/github/issues/issues/2552 where a nested <ul> in a footnote would look broken.

Before After
Screen Shot 2022-09-23 at 20 26 15 Screen Shot 2022-09-23 at 21 12 38

What approach did you choose and why?

Using inline-block for the nested <ul> makes sure the ↩︎ stays on the same line. Also fixed a bit the padding/margin.

What should reviewers focus on

An alternative would be to not allow using - (unordered list) in footnotes since footnotes are already ordered lists. But we don't really have control over the user generated markdown and omitting/removing the - (unordered list) in footnotes might also be considered as a bug? 🤔

Can these changes ship as is?

  • Yes, this PR does not depend on additional changes. 🚢

@changeset-bot
Copy link

changeset-bot bot commented Sep 23, 2022

🦋 Changeset detected

Latest commit: 981d468

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/css Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@simurai
Copy link
Contributor Author

simurai commented Sep 23, 2022

Bellow raw Markdown and how it renders (currently still broken):

A footnote with a nested `<ul>` [^1]

[^1]: - footnote

👇

A footnote with a nested <ul> 1

Footnotes

    • footnote

@github-actions github-actions bot temporarily deployed to Storybook Preview September 23, 2022 12:27 Inactive
@simurai simurai temporarily deployed to github-pages September 23, 2022 12:33 Inactive
@github-actions github-actions bot temporarily deployed to Storybook Preview September 23, 2022 12:33 Inactive
@simurai simurai marked this pull request as ready for review September 26, 2022 01:58
@simurai simurai requested a review from a team as a code owner September 26, 2022 01:58
@simurai simurai requested a review from langermank September 26, 2022 01:58
@simurai simurai enabled auto-merge (squash) September 28, 2022 04:19
@simurai simurai merged commit 6569fb3 into main Sep 28, 2022
@simurai simurai deleted the footnotes branch September 28, 2022 04:20
@primer-css primer-css mentioned this pull request Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants