| 1 |
# Project Information: https://www.mkdocs.org/user-guide/configuration/#project-information |
| 2 |
site_name: Shoutrrr |
| 3 |
site_url: https://shoutrrr.nickfedor.com/ |
| 4 |
repo_name: nicholas-fedor/shoutrrr |
| 5 |
repo_url: https://github.com/nicholas-fedor/shoutrrr/ |
| 6 |
# Path from repo_url to the docs directory for direct editing links, set to main branch. |
| 7 |
edit_uri: edit/main/docs/ |
| 8 |
# Description for meta tags in HTML header. |
| 9 |
site_description: Documentation for Shoutrrr, a notification library for gophers and their furry friends. Heavily inspired by caronc/apprise. |
| 10 |
# Author name for meta tags in HTML header. |
| 11 |
site_author: Nicholas Fedor |
| 12 |
# Copyright information displayed in the documentation footer (Material theme). |
| 13 |
copyright: Copyright © 2026 Nicholas Fedor |
| 14 |
|
| 15 |
# Theme Configuration: https://www.mkdocs.org/user-guide/configuration/#theme |
| 16 |
theme: |
| 17 |
name: "material" |
| 18 |
# Custom color scheme for the Material theme, defined in custom CSS or overrides. |
| 19 |
palette: |
| 20 |
scheme: shoutrrr |
| 21 |
# Logo image for the site header, relative to docs_dir. |
| 22 |
logo: assets/media/shoutrrr-180px.png |
| 23 |
# Git icon for the site header. |
| 24 |
icon: |
| 25 |
repo: fontawesome/brands/github |
| 26 |
# Favicon for the site, relative to docs_dir. |
| 27 |
favicon: assets/media/favicon.ico |
| 28 |
# Directory for custom theme overrides, e.g., partials or main.html. |
| 29 |
custom_dir: ../../docs/overrides |
| 30 |
# Material theme features for enhanced navigation and usability. |
| 31 |
features: |
| 32 |
- navigation.tabs |
| 33 |
- navigation.sections |
| 34 |
- navigation.expand |
| 35 |
- toc.follow |
| 36 |
- search.suggest |
| 37 |
- search.highlight |
| 38 |
- content.code.copy |
| 39 |
- content.tooltips |
| 40 |
- content.tabs.link |
| 41 |
- navigation.top |
| 42 |
|
| 43 |
# Extra Configuration: Passed to templates for flexibility. |
| 44 |
extra: |
| 45 |
# Version provider for the mike plugin to handle versioned documentation. |
| 46 |
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning |
| 47 |
version: |
| 48 |
provider: mike |
| 49 |
alias: true |
| 50 |
default: |
| 51 |
- latest |
| 52 |
- dev |
| 53 |
# Disables the "Made with MkDocs" generator text in the footer. |
| 54 |
generator: false |
| 55 |
# Social links displayed as icons in the footer (Material theme). |
| 56 |
social: |
| 57 |
- icon: fontawesome/brands/github |
| 58 |
link: https://github.com/nicholas-fedor/shoutrrr |
| 59 |
|
| 60 |
# Extra CSS: Stylesheets included by the theme, relative to docs_dir. |
| 61 |
extra_css: |
| 62 |
- assets/styles/theme.css |
| 63 |
- assets/styles/extra.css |
| 64 |
|
| 65 |
# Markdown Extensions: https://www.mkdocs.org/user-guide/configuration/#markdown_extensions |
| 66 |
# Custom formatting extensions beyond default meta, toc, tables, and fenced_code. |
| 67 |
markdown_extensions: |
| 68 |
- toc: |
| 69 |
# Enables permalinks for table of contents headings. |
| 70 |
permalink: true |
| 71 |
# Separator for permalinks in table of contents. |
| 72 |
separator: "_" |
| 73 |
# Enables admonition blocks (e.g., note, warning). |
| 74 |
- admonition |
| 75 |
# Enables collapsible details blocks. |
| 76 |
- pymdownx.details |
| 77 |
# Enables code highlighting for fenced code blocks. |
| 78 |
- pymdownx.highlight |
| 79 |
# Enables inline code highlighting. |
| 80 |
- pymdownx.inlinehilite |
| 81 |
# Enables nested fenced code blocks. |
| 82 |
- pymdownx.superfences |
| 83 |
# Enables text highlighting with == or !! markers. |
| 84 |
- pymdownx.mark |
| 85 |
# Enables snippet inclusion with path validation. |
| 86 |
- pymdownx.snippets: |
| 87 |
# Toggle to disabled for local development |
| 88 |
check_paths: true |
| 89 |
# Enables tabbed content blocks for examples or comparisons. |
| 90 |
- pymdownx.tabbed: |
| 91 |
alternate_style: true |
| 92 |
# Enables task lists with checkboxes. |
| 93 |
- pymdownx.tasklist: |
| 94 |
custom_checkbox: true |
| 95 |
# Enables attribute lists for adding classes or IDs to Markdown elements. |
| 96 |
- attr_list |
| 97 |
# Enables footnote references in Markdown. |
| 98 |
- footnotes |
| 99 |
|
| 100 |
# Navigation: https://www.mkdocs.org/user-guide/configuration/#nav |
| 101 |
# Site structure with paths relative to docs_dir. |
| 102 |
nav: |
| 103 |
- Home: index.md |
| 104 |
- Installation: installation/index.md |
| 105 |
- Usage: |
| 106 |
- Overview: usage/index.md |
| 107 |
- CLI: |
| 108 |
- Overview: usage/cli/index.md |
| 109 |
- Commands: |
| 110 |
- Completion: usage/cli/completion/index.md |
| 111 |
- Docs: usage/cli/docs/index.md |
| 112 |
- Generate: usage/cli/generate/index.md |
| 113 |
- Help: usage/cli/help/index.md |
| 114 |
- Send: usage/cli/send/index.md |
| 115 |
- Verify: usage/cli/verify/index.md |
| 116 |
- Docker: usage/docker/index.md |
| 117 |
- GitHub Action: usage/github-action/index.md |
| 118 |
- Go Package: usage/go-package/index.md |
| 119 |
- Services: |
| 120 |
- Overview: services/overview.md |
| 121 |
- Chat and Messaging Platforms: |
| 122 |
- Discord: services/chat/discord/index.md |
| 123 |
- Google Chat: services/chat/googlechat/index.md |
| 124 |
- Hangouts: services/chat/hangouts/index.md |
| 125 |
- Lark: services/chat/lark/index.md |
| 126 |
- Matrix: services/chat/matrix/index.md |
| 127 |
- Mattermost: services/chat/mattermost/index.md |
| 128 |
- Rocket.Chat: services/chat/rocketchat/index.md |
| 129 |
- Signal: services/chat/signal/index.md |
| 130 |
- Slack: services/chat/slack/index.md |
| 131 |
- Teams: services/chat/teams/index.md |
| 132 |
- Telegram: services/chat/telegram/index.md |
| 133 |
- WeCom: services/chat/wecom/index.md |
| 134 |
- Zulip: services/chat/zulip/index.md |
| 135 |
- Push Notification Services: |
| 136 |
- Bark: services/push/bark/index.md |
| 137 |
- Gotify: services/push/gotify/index.md |
| 138 |
- IFTTT: services/push/ifttt/index.md |
| 139 |
- Join: services/push/join/index.md |
| 140 |
- MQTT: services/push/mqtt/index.md |
| 141 |
- Ntfy: services/push/ntfy/index.md |
| 142 |
- Pushbullet: services/push/pushbullet/index.md |
| 143 |
- Pushover: services/push/pushover/index.md |
| 144 |
- Incident and Alert Management: |
| 145 |
- OpsGenie: services/incident/opsgenie/index.md |
| 146 |
- PagerDuty: services/incident/pagerduty/index.md |
| 147 |
- Email Services: |
| 148 |
- SMTP: services/email/smtp/index.md |
| 149 |
- SMS Services: |
| 150 |
- Twilio: services/sms/twilio/index.md |
| 151 |
- Specialized Services: |
| 152 |
- Generic: services/specialized/generic/index.md |
| 153 |
- Logger: services/specialized/logger/index.md |
| 154 |
- Notifiarr: services/specialized/notifiarr/index.md |
| 155 |
- Guides: |
| 156 |
- Configuring Slack: guides/slack/index.md |
| 157 |
- Proxy Setup: guides/proxy/index.md |
| 158 |
- Examples: |
| 159 |
- Home Assistant: examples/home-assistant/index.md |
| 160 |
- Playground: playground/index.md |
| 161 |
|
| 162 |
# Plugins: https://www.mkdocs.org/user-guide/configuration/#plugins |
| 163 |
# Additional functionality for the site build. |
| 164 |
plugins: |
| 165 |
# Enables search functionality with lunr.js. |
| 166 |
- search |
| 167 |
# Enables versioned documentation with version selector. |
| 168 |
- mike: |
| 169 |
version_selector: true |
| 170 |
css_dir: assets/styles |
| 171 |
alias_type: redirect |
| 172 |
# Displays last updated dates on pages, formatted as time ago. |
| 173 |
- git-revision-date-localized: |
| 174 |
enable_creation_date: true |
| 175 |
enable_git_follow: false |
| 176 |
type: timeago |
| 177 |
|
| 178 |
# Build Directories: https://www.mkdocs.org/user-guide/configuration/#build-directories |
| 179 |
# Default directories for documentation source and output. |
| 180 |
docs_dir: ../../docs |
| 181 |
site_dir: ../../site |
| 182 |
|
| 183 |
# Exclude Go WASM source from docs processing. |
| 184 |
exclude_docs: "playground/wasm/" |
| 185 |
|
| 186 |
# Validation: https://www.mkdocs.org/user-guide/configuration/#validation |
| 187 |
# Strictness settings for link validation during builds. |
| 188 |
validation: |
| 189 |
nav: |
| 190 |
# Warns if files in docs_dir are not in nav. |
| 191 |
omitted_files: warn |
| 192 |
# Warns if absolute links are used in nav. |
| 193 |
absolute_links: warn |
| 194 |
links: |
| 195 |
# Warns if linked files are not found. |
| 196 |
not_found: warn |
| 197 |
# Warns if anchors in links do not exist. |
| 198 |
anchors: warn |
| 199 |
# Treats absolute links as relative to docs_dir for validation. |
| 200 |
absolute_links: relative_to_docs |
| 201 |
# Warns if relative links are unrecognized. |
| 202 |
unrecognized_links: warn |
| 203 |
|
| 204 |
# Live Reloading: https://www.mkdocs.org/user-guide/configuration/#live-reloading |
| 205 |
# Directories to watch for changes during mkdocs serve. |
| 206 |
watch: |
| 207 |
- ../../docs |