2021-12-02 22:27:31 +00:00
|
|
|
site_dir: server/docs
|
|
|
|
|
site_name: ntfy
|
2021-12-02 04:08:12 +00:00
|
|
|
site_url: https://ntfy.sh
|
2021-12-17 14:32:59 +00:00
|
|
|
site_description: Send push notifications to your phone via PUT/POST
|
2021-12-02 04:08:12 +00:00
|
|
|
copyright: Made with ❤️ by Philipp C. Heckel
|
|
|
|
|
repo_name: binwiederhier/ntfy
|
|
|
|
|
repo_url: https://github.com/binwiederhier/ntfy
|
2021-12-17 14:32:59 +00:00
|
|
|
edit_uri: blob/main/docs/
|
2021-12-02 04:08:12 +00:00
|
|
|
|
|
|
|
|
theme:
|
|
|
|
|
name: material
|
2023-03-12 19:07:42 +00:00
|
|
|
font: false
|
2021-12-02 04:08:12 +00:00
|
|
|
language: en
|
2023-02-20 14:19:51 +00:00
|
|
|
custom_dir: docs/_overrides
|
2021-12-02 04:08:12 +00:00
|
|
|
logo: static/img/ntfy.png
|
|
|
|
|
favicon: static/img/favicon.png
|
|
|
|
|
include_search_page: false
|
|
|
|
|
search_index_only: true
|
|
|
|
|
palette:
|
|
|
|
|
- media: "(prefers-color-scheme: light)" # Light mode
|
|
|
|
|
scheme: default
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb-outline
|
2021-12-07 01:05:06 +00:00
|
|
|
name: Switch to dark mode
|
2021-12-02 04:08:12 +00:00
|
|
|
- media: "(prefers-color-scheme: dark)" # Dark mode
|
|
|
|
|
scheme: slate
|
|
|
|
|
accent: indigo
|
|
|
|
|
toggle:
|
|
|
|
|
icon: material/lightbulb
|
2021-12-07 01:05:06 +00:00
|
|
|
name: Switch to light mode
|
2021-12-02 04:08:12 +00:00
|
|
|
features:
|
|
|
|
|
- search.suggest
|
|
|
|
|
- search.highlight
|
|
|
|
|
- search.share
|
|
|
|
|
- navigation.sections
|
|
|
|
|
- toc.integrate
|
|
|
|
|
- content.tabs.link
|
2021-12-05 01:23:29 +00:00
|
|
|
extra:
|
|
|
|
|
homepage: /
|
|
|
|
|
social:
|
|
|
|
|
- icon: fontawesome/brands/github-alt
|
|
|
|
|
link: https://github.com/binwiederhier
|
2021-12-02 04:08:12 +00:00
|
|
|
extra_javascript:
|
|
|
|
|
- static/js/extra.js
|
|
|
|
|
extra_css:
|
|
|
|
|
- static/css/extra.css
|
|
|
|
|
|
|
|
|
|
markdown_extensions:
|
|
|
|
|
- admonition
|
|
|
|
|
- meta
|
|
|
|
|
- toc:
|
|
|
|
|
permalink: true
|
|
|
|
|
- pymdownx.tabbed:
|
|
|
|
|
alternate_style: true
|
|
|
|
|
- pymdownx.superfences
|
2021-12-04 01:38:21 +00:00
|
|
|
- pymdownx.highlight:
|
|
|
|
|
extend_pygments_lang:
|
|
|
|
|
- name: php-inline
|
|
|
|
|
lang: php
|
|
|
|
|
options:
|
|
|
|
|
startinline: true
|
2021-12-02 04:08:12 +00:00
|
|
|
- pymdownx.tasklist:
|
|
|
|
|
custom_checkbox: true
|
|
|
|
|
- attr_list
|
|
|
|
|
- md_in_html
|
2022-05-26 20:22:47 +00:00
|
|
|
- pymdownx.emoji:
|
|
|
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
|
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
2021-12-02 04:08:12 +00:00
|
|
|
|
|
|
|
|
plugins:
|
|
|
|
|
- search
|
2021-12-05 04:37:50 +00:00
|
|
|
- minify:
|
|
|
|
|
minify_html: true
|
2023-03-12 19:32:25 +00:00
|
|
|
- mkdocs-simple-hooks:
|
|
|
|
|
hooks:
|
|
|
|
|
on_post_build: "docs.hooks:copy_fonts"
|
2021-12-02 04:08:12 +00:00
|
|
|
|
|
|
|
|
nav:
|
|
|
|
|
- "Getting started": index.md
|
|
|
|
|
- "Publishing":
|
2021-12-02 22:27:31 +00:00
|
|
|
- "Sending messages": publish.md
|
2021-12-02 04:08:12 +00:00
|
|
|
- "Subscribing":
|
2021-12-05 01:23:29 +00:00
|
|
|
- "From your phone": subscribe/phone.md
|
2023-02-15 20:39:01 +00:00
|
|
|
- "From the Web app": subscribe/web.md
|
2021-12-20 02:01:49 +00:00
|
|
|
- "From the CLI": subscribe/cli.md
|
2021-12-05 01:23:29 +00:00
|
|
|
- "Using the API": subscribe/api.md
|
|
|
|
|
- "Self-hosting":
|
|
|
|
|
- "Installation": install.md
|
|
|
|
|
- "Configuration": config.md
|
2021-12-02 04:08:12 +00:00
|
|
|
- "Other things":
|
2021-12-05 01:23:29 +00:00
|
|
|
- "FAQs": faq.md
|
2021-12-02 04:08:12 +00:00
|
|
|
- "Examples": examples.md
|
2022-08-21 02:22:18 +00:00
|
|
|
- "Integrations + projects": integrations.md
|
2022-02-27 20:45:43 +00:00
|
|
|
- "Release notes": releases.md
|
|
|
|
|
- "Emojis 🥳 🎉": emojis.md
|
2022-12-21 02:58:54 +00:00
|
|
|
- "Known issues": known-issues.md
|
|
|
|
|
- "Deprecation notices": deprecations.md
|
2021-12-02 04:08:12 +00:00
|
|
|
- "Development": develop.md
|
2021-12-05 01:23:29 +00:00
|
|
|
- "Privacy policy": privacy.md
|
2021-12-02 04:08:12 +00:00
|
|
|
|
|
|
|
|
|
