Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken style: ref-header #94

Open
jeff-matthews opened this issue Sep 8, 2021 · 2 comments
Open

Broken style: ref-header #94

jeff-matthews opened this issue Sep 8, 2021 · 2 comments
Assignees
Labels

Comments

@jeff-matthews
Copy link
Contributor

Bug report

I just noticed this, but the style appears to be broken. I'm not sure how long it's been this way because we haven't had any reports. It probably happened recently during branding updates for the theme, which included some spectrum CSS upgrades.

Screen Shot 2021-09-08 at 10 09 12 AM

Background

When we implemented MD linting in devdocs, we were forced to create a style called ref-header to act as a pseudo heading for the "Related topics" section at the bottom of some pages on devdocs.

The motivation was to have a heading that stands out but doesn't appear in the "On this page" navigation on the right side of each page. Using the no_toc class was not a viable option because it violates MD linting rules.

@jeff-matthews
Copy link
Contributor Author

I just ran a local MD lint test, and it appears that there's no longer a failure on the following:

## Related topics
{:.no_toc}

So we wither need to fix the style or remove it and replace all references to it in devdocs.

@bdenham bdenham self-assigned this Sep 9, 2021
@jeff-matthews
Copy link
Contributor Author

This style is actually defined in the devdocs project, not the theme.

https://github.com/magento/devdocs/blob/master/src/common/css/devdocs.css#L15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants