Prerequisites to reduce duplicate content #1695
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
To avoid duplicating content, we want to write brand specific sections of mdx using .astro components to render portions of mdx only for select brands. However Starlight finds headings by inspecting mdx before this happens. This means content is hidden correctly, but there are links within table of contents components (sidebar, in page links) which show links to headings which do not exist on branded pages. This post-process script removes heading links from table of content components where the heading does not exist on the page. It is a little fragile, as it depends on Strlight markup not changing. We decided as a team this is a reasonable approach for the medium term. It was our prefered approach compared with maintaining a fork, or other much more time consuming customisations. We anticipate moving away from Starlight in 2025 to re-brand Origami to the FT Design System.
We "brand" content using Starlight's internationalisation feature. We duplicate lots of content currently as we need to make small content changes per brand (language), e.g. to show a "mono" theme for the button component only for the "core" brand. If we pass the brand (language) to mdx we can avoid duplicating content (super hard to manage) and instead show this section on condition of the current brand. We intent to make an upstream PR to pass down this data. In the meantime, we patch.
akomiqaia
approved these changes
Jun 6, 2024
frshwtr
reviewed
Jun 6, 2024
| const items = tocComponent.querySelectorAll('li'); | ||
| const extraItems = Array.from(items).filter(item => { | ||
| const anchor = item.querySelector('a'); | ||
| const anchorId = anchor.href.replace(/^(.+)#/, ''); |
There was a problem hiding this comment.
Think we might have runtime probllem here if no a's come back. Possibly want to ignore filtering this specific element if there's no a?
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.
See commit messages.