Demote headings appearing in markdown #166
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, datahub can store arbitrary markdown in description fields. When we render this, it interferes with the normal heading structure of the page, because we have H1s following H3s etc. This markdown extension fixes this problem by automatically demoting headings a number of levels depending on the context we are rendering in. This solution isn't perfect, because sometimes layout headings use a smaller font size than the default for the corresponding level. Markdown rendered headings always use the default defined by the design system, so in such cases we may need to skip a level to get consistent sizing.
tom-webber
approved these changes
Mar 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, datahub can store arbitrary markdown in description fields. When we render this, it interferes with the normal heading structure of the page, because we have H1s following H3s etc.
This is partly a content problem - the documentation we've scraped from the preexisting data discovery tool is not designed for the new data catalogue - but we want the frontend to do the best it can even in the worst case scenario.
The
mdx_headdownmarkdown extension fixes this problem by automatically demoting headings a number of levels depending on the context we are rendering in.This solution isn't perfect, because sometimes layout headings use a smaller font size than the default for the corresponding level. Markdown rendered headings always use the default defined by the design system, so in such cases we may need to skip a level to get consistent sizing.
Before
After