ntfy/mkdocs.yml

90 lines
2.0 KiB
YAML
Raw Normal View History

2021-12-02 23:27:31 +01:00
site_dir: server/docs
site_name: ntfy
2021-12-02 05:08:12 +01:00
site_url: https://ntfy.sh
site_description: simple HTTP-based pub-sub
copyright: Made with ❤️ by Philipp C. Heckel
repo_name: binwiederhier/ntfy
repo_url: https://github.com/binwiederhier/ntfy
edit_uri: edit/main/docs/
theme:
name: material
language: en
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
name: Switch to light mode
- media: "(prefers-color-scheme: dark)" # Dark mode
scheme: slate
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
- search.share
- navigation.sections
2021-12-05 05:37:50 +01:00
# - navigation.instant
2021-12-02 05:08:12 +01:00
- toc.integrate
- content.tabs.link
2021-12-05 02:23:29 +01:00
extra:
homepage: /
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/binwiederhier
2021-12-02 05:08:12 +01: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 02:38:21 +01:00
- pymdownx.highlight:
extend_pygments_lang:
- name: php-inline
lang: php
options:
startinline: true
2021-12-02 05:08:12 +01:00
- pymdownx.tasklist:
custom_checkbox: true
- attr_list
- md_in_html
plugins:
- search
2021-12-05 05:37:50 +01:00
- minify:
minify_html: true
2021-12-02 05:08:12 +01:00
nav:
- "Getting started": index.md
- "Publishing":
2021-12-02 23:27:31 +01:00
- "Sending messages": publish.md
2021-12-02 05:08:12 +01:00
- "Subscribing":
2021-12-05 02:23:29 +01:00
- "From your phone": subscribe/phone.md
- "From the Web UI": subscribe/web.md
- "Using the API": subscribe/api.md
- "Self-hosting":
- "Installation": install.md
- "Configuration": config.md
2021-12-02 05:08:12 +01:00
- "Other things":
2021-12-05 02:23:29 +01:00
- "FAQs": faq.md
2021-12-02 05:08:12 +01:00
- "Examples": examples.md
2021-12-02 18:04:22 +01:00
- "Emojis 🥳 🎉": emojis.md
2021-12-02 05:08:12 +01:00
- "Development": develop.md
2021-12-05 02:23:29 +01:00
- "Privacy policy": privacy.md
2021-12-02 05:08:12 +01:00