mirror of
https://github.com/TRaSH-Guides/Guides.git
synced 2026-05-19 15:58:42 -05:00
bakerboy448
d15d3362ac
* feat: add navigation prefetch and progress bar
- `navigation.instant.prefetch`: Preloads pages when users hover over
links, making navigation feel instant on subsequent clicks.
- `navigation.instant.progress`: Shows a slim progress indicator at
the top of the page on slower connections, providing visual feedback
that a page is loading.
Both features build on the existing `navigation.instant` and require
no additional configuration.
* feat: add search suggestions, highlighting, and TOC follow
- `search.suggest`: Shows autocomplete suggestions in the search bar
as users type, helping them find content faster.
- `search.highlight`: Highlights matching search terms on the target
page after clicking a result, making it easy to spot relevant text.
- `toc.follow`: Automatically scrolls the table of contents sidebar
to keep the active heading visible, so users always know where they
are in long pages.
* fix: remove duplicate pymdownx.tabbed entry
The extension was listed twice: once without options (line 57) and
once with `alternate_style: true` (line 60). The duplicate bare entry
is redundant and may cause unexpected behavior. The configured entry
with `alternate_style` is the correct one per Material for MkDocs
requirements since v9.
* fix: use standard permalink icon for table of contents
Changes `permalink: ""` to `permalink: true`. The empty string
renders an invisible/empty permalink anchor on every heading, which
means the feature is technically active but users can't see or click
the link icon. Setting it to `true` uses Material's default pilcrow
(¶) icon, making heading permalinks visible and clickable for easy
sharing of direct links to specific sections.
* feat: add syntax highlighting enhancements
Adds three options to `pymdownx.highlight` and the `pymdownx.inlinehilite`
extension:
- `anchor_linenums: true`: Makes line numbers in code blocks clickable
anchors, allowing users to link directly to specific lines.
- `line_spans: __span`: Wraps each line in a span element, enabling
per-line styling (e.g., highlighting specific lines).
- `pygments_lang_class: true`: Adds the language name as a CSS class
to code blocks, allowing language-specific styling.
- `pymdownx.inlinehilite`: Enables syntax highlighting in inline code
using the `#!language code` syntax (e.g., `#!python print("hello")`).
Useful for referencing code snippets within paragraph text.
* Change toc permalink setting to an empty string
197 lines
7.5 KiB
YAML
197 lines
7.5 KiB
YAML
site_name: TRaSH Guides
|
|
site_description: TRaSH-Guides is a comprehensive collection of guides for Radarr, Sonarr, and related media management tools. These guides answer common questions and provide the best settings for your entire media server setup.
|
|
site_author: TRaSH
|
|
site_url: https://trash-guides.info/
|
|
|
|
repo_url: https://github.com/TRaSH-Guides/Guides
|
|
repo_name: TRaSH-Guides
|
|
|
|
# ignores absolute warnings we have
|
|
# warns on missing/broken links
|
|
validation:
|
|
omitted_files: warn
|
|
not_found: warn
|
|
absolute_links: ignore
|
|
# fails to build on warnings
|
|
strict: true
|
|
|
|
copyright: Copyright © 2025 TRaSH
|
|
|
|
extra:
|
|
analytics:
|
|
provider: google
|
|
property: G-ZZKM4MPQXL
|
|
social:
|
|
- icon: fontawesome/brands/discord
|
|
link: https://trash-guides.info/discord
|
|
- icon: fontawesome/brands/square-github
|
|
link: https://github.com/TRaSH-Guides/Guides
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
- stylesheets/github-permalink-style.css
|
|
|
|
extra_javascript:
|
|
- js/hide_announce.js
|
|
|
|
markdown_extensions:
|
|
- abbr # used for Tooltips
|
|
- attr_list
|
|
- md_in_html # used for Annotations
|
|
- admonition
|
|
- pymdownx.caret
|
|
- pymdownx.critic
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
options:
|
|
custom_icons:
|
|
- overrides/.icons
|
|
- pymdownx.extra
|
|
- pymdownx.highlight:
|
|
guess_lang: true
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.snippets
|
|
- pymdownx.tilde
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
|
kwds:
|
|
case: lower
|
|
- toc:
|
|
permalink: ""
|
|
# toc_depth: 5
|
|
|
|
plugins:
|
|
- include-markdown:
|
|
opening_tag: "{!"
|
|
closing_tag: "!}"
|
|
- markdownextradata:
|
|
data: docs/json
|
|
- search
|
|
- git-revision-date-localized:
|
|
type: datetime
|
|
locale: en
|
|
fallback_to_build_date: true
|
|
enable_creation_date: true
|
|
- awesome-pages
|
|
- glightbox:
|
|
touchNavigation: true
|
|
loop: false
|
|
effect: zoom
|
|
width: 100%
|
|
height: auto
|
|
zoomable: true
|
|
draggable: true
|
|
auto_caption: false
|
|
caption_position: bottom
|
|
- macros:
|
|
j2_block_start_string: "[[%"
|
|
j2_block_end_string: "%]]"
|
|
j2_variable_start_string: "[["
|
|
j2_variable_end_string: "]]"
|
|
- redirects:
|
|
redirect_maps:
|
|
#updates.txt: updates.txt
|
|
discord.md: https://discord.gg/4K2kdvwzFh
|
|
syno-script.md: https://github.com/TRaSH-/Guides-Synology-Templates/blob/main/script/trash_syno_installer.sh
|
|
# Radarr redirects
|
|
Radarr/Radarr-setup-custom-formats.md: Radarr/radarr-setup-quality-profiles.md
|
|
Radarr/radarr-setup-custom-formats-anime.md: Radarr/radarr-setup-quality-profiles-anime.md
|
|
Radarr/radarr-setup-custom-formats-french.md: Radarr/radarr-setup-quality-profiles-french-en.md
|
|
Radarr/Radarr-remote-path-mapping.md: Radarr/Tips/Radarr-remote-path-mapping.md
|
|
# Sonarr redirects
|
|
Sonarr/sonarr-setup-custom-formats.md: Sonarr/sonarr-setup-quality-profiles.md
|
|
Sonarr/sonarr-setup-custom-formats-anime.md: Sonarr/sonarr-setup-quality-profiles-anime.md
|
|
Sonarr/Sonarr-Release-Profile-RegEx.md: Sonarr/sonarr-v3-eol.md
|
|
Sonarr/Sonarr-Release-Profile-RegEx-Anime.md: Sonarr/sonarr-v3-eol.md
|
|
Sonarr/Sonarr-remote-path-mapping.md: Sonarr/Tips/Sonarr-remote-path-mapping.md
|
|
# How to old redirects
|
|
How-to-setup-for/index.md: File-and-Folder-Structure/How-to-set-up/index.md
|
|
How-to-setup-for/Docker.md: File-and-Folder-Structure/How-to-set-up/Docker.md
|
|
How-to-setup-for/Dockstarter.md: File-and-Folder-Structure/How-to-set-up/Dockstarter.md
|
|
How-to-setup-for/Native.md: File-and-Folder-Structure/How-to-set-up/Native.md
|
|
How-to-setup-for/Synology.md: File-and-Folder-Structure/How-to-set-up/Synology.md
|
|
How-to-setup-for/Unraid.md: File-and-Folder-Structure/How-to-set-up/Unraid.md
|
|
# Hardlink to File-and-Folder-Structure redirects
|
|
Hardlinks/Check-if-hardlinks-are-working.md: File-and-Folder-Structure/Check-if-hardlinks-are-working.md
|
|
Hardlinks/Examples.md: File-and-Folder-Structure/Examples.md
|
|
Hardlinks/Hardlinks-and-Instant-Moves.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md
|
|
Hardlinks/index.md: File-and-Folder-Structure/index.md
|
|
Hardlinks/Replace-copies-with-hardlinks.md: File-and-Folder-Structure/Replace-copies-with-hardlinks.md
|
|
Hardlinks/How-to-setup-for/Docker.md: File-and-Folder-Structure/How-to-set-up/Docker.md
|
|
Hardlinks/How-to-setup-for/Dockstarter.md: File-and-Folder-Structure/How-to-set-up/Dockstarter.md
|
|
Hardlinks/How-to-setup-for/index.md: File-and-Folder-Structure/How-to-set-up/index.md
|
|
Hardlinks/How-to-setup-for/Native.md: File-and-Folder-Structure/How-to-set-up/Native.md
|
|
Hardlinks/How-to-setup-for/Synology.md: File-and-Folder-Structure/How-to-set-up/Synology.md
|
|
Hardlinks/How-to-setup-for/TrueNAS-Core.md: File-and-Folder-Structure/How-to-set-up/TrueNAS-Core.md
|
|
Hardlinks/How-to-setup-for/Unraid.md: File-and-Folder-Structure/How-to-set-up/Unraid.md
|
|
Hardlinks/How-to-setup-for/Windows.md: File-and-Folder-Structure/How-to-set-up/Windows.md
|
|
# Random redirects
|
|
Misc/trash-sync.md: Guide-Sync/index.md
|
|
# Shortcuts redirects
|
|
hardlinks.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md
|
|
hardlink.md: File-and-Folder-Structure/Hardlinks-and-Instant-Moves.md
|
|
check-hardlinks.md: File-and-Folder-Structure/Check-if-hardlinks-are-working.md
|
|
custom-formats.md: Radarr/Radarr-collection-of-custom-formats.md
|
|
cf.md: Radarr/Radarr-collection-of-custom-formats.md
|
|
TorGuard.md: Misc/How-to-setup-Torguard-for-port-forwarding.md
|
|
torguard.md: Misc/How-to-setup-Torguard-for-port-forwarding.md
|
|
compose.md: Misc/how-to-provide-a-docker-compose.md
|
|
Golden-Rule.md: Misc/x265-4k.md
|
|
show-unknown.md: Radarr/Tips/Radarr-show-unknown-movie-items.md
|
|
merge-quality.md: Radarr/Tips/Merge-quality.md
|
|
jdupes.md: File-and-Folder-Structure/Replace-copies-with-hardlinks.md
|
|
# Recyclarr redirects
|
|
Recyclarr/recyclarr-configs.md: https://recyclarr.dev/wiki/guide-configs/
|
|
Recyclarr/recyclarr-configs-sqp.md: https://recyclarr.dev/wiki/sqp-configs/
|
|
# Downloaders redirects
|
|
Downloaders/qBittorrent/3rd-party-tools.md: Downloaders/3rd-party-tools.md
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: overrides
|
|
features:
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.tabs
|
|
- navigation.top
|
|
- content.code.copy
|
|
- content.action.edit
|
|
- content.action.view
|
|
- content.tooltips
|
|
- search.suggest
|
|
- search.highlight
|
|
- toc.follow
|
|
language: en
|
|
palette:
|
|
- media: "(prefers-color-scheme: dark)"
|
|
primary: indigo
|
|
accent: blue
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/toggle-switch
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
primary: indigo
|
|
accent: blue
|
|
scheme: default
|
|
toggle:
|
|
icon: material/toggle-switch-off-outline
|
|
name: Switch to dark mode
|
|
font:
|
|
text: "Noto Sans"
|
|
code: "Encode Sans Expanded"
|
|
favicon: img/favicon.png
|
|
logo: img/logo.png
|
|
icon:
|
|
annotation: circle-question
|