TRaSH-Guides / Guides

Here you will find Guides mainly for the Starr Apps (Sonarr/Radarr) and everything related to it.
https://trash-guides.info/
MIT License
1.62k stars 208 forks source link

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

Open notifiarr-bot opened 1 month ago

notifiarr-bot commented 1 month ago

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- commented 1 month ago

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 commented 1 month ago

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- commented 1 month ago

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