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

[Request] (Guide): Consistency for HDR10Plus (replace instances of HDR10+ in documentation) #1935

Closed
notifiarr-bot opened this issue May 15, 2024 · 3 comments
Labels
Status: Declined Declined the Fix/Guide Request etc. Won't Fix

Comments

@notifiarr-bot
Copy link

so the CF name uses DD+ and HDR10+ but the anchors need to use DDPlus and HDR10Plus

Origin user: trash.guides
Origin message: Discord Server Link
Reporting user: yammes
Reporting message: Discord Server Link

@TRaSH-
Copy link
Contributor

TRaSH- commented May 15, 2024

Wonder where in the guide we've the inconsistent
We use DD+/HDR10+ as CF name because it was the preferred option, but mkdocs can't handle special characters as anchors, so for the anchors we replace the + sign for Plus. So everywhere where we talk about DD+/HDR10+ we use DD+/HDR10+ but when we need to use anchors we use DDPlus and HDR10Plus

@asherbig
Copy link

asherbig commented May 16, 2024

It may be possible to manually specify the ID for the anchor. https://www.markdownguide.org/extended-syntax/#heading-ids.

Many Markdown processors support custom IDs for headings — some Markdown processors automatically add them. Adding custom IDs allows you to link directly to headings and modify them with CSS. To add a custom heading ID, enclose the custom ID in curly braces on the same line as the heading.

### My Great Heading {#custom-id}
The HTML looks like this:

<h3 id="custom-id">My Great Heading</h3>

I'm not sure if MkDocs supports this - I would test it, but it's late where I am, and wanted to drop this in here before I forget. If this works though, then you could use HDR10+ for the header text, and hdr10plus as the header ID.

@TRaSH-
Copy link
Contributor

TRaSH- commented May 16, 2024

will probably break more then fix, especially in the tables. or when we want to re-direct it from a guide to it and make it more overcomplicated then plain using what we use now

@nuxencs nuxencs changed the title (guides) ensure guides consistency for HDR10Plus (replace instances of HDR10+ in documentation) [Request] (Guide): Consistency for HDR10Plus (replace instances of HDR10+ in documentation) May 20, 2024
@TRaSH- TRaSH- added Status: Feedback Needed Awaiting Feedback or Discussion Priority: Low labels Jun 10, 2024
@TRaSH- TRaSH- added Status: Declined Declined the Fix/Guide Request etc. Won't Fix and removed Status: Feedback Needed Awaiting Feedback or Discussion Priority: Low labels Sep 25, 2024
@TRaSH- TRaSH- closed this as not planned Won't fix, can't repro, duplicate, stale Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Declined Declined the Fix/Guide Request etc. Won't Fix
Projects
None yet
Development

No branches or pull requests

3 participants