mkdocs.yml 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. site_dir: server/docs
  2. site_name: ntfy
  3. site_url: https://ntfy.sh
  4. site_description: Send push notifications to your phone via PUT/POST
  5. copyright: Made with ❤️ by Philipp C. Heckel
  6. repo_name: binwiederhier/ntfy
  7. repo_url: https://github.com/binwiederhier/ntfy
  8. edit_uri: blob/main/docs/
  9. theme:
  10. name: material
  11. font: false
  12. language: en
  13. custom_dir: docs/_overrides
  14. logo: static/img/ntfy.png
  15. favicon: static/img/favicon.ico
  16. include_search_page: false
  17. search_index_only: true
  18. palette:
  19. - media: "(prefers-color-scheme: light)" # Light mode
  20. scheme: default
  21. toggle:
  22. icon: material/lightbulb-outline
  23. name: Switch to dark mode
  24. - media: "(prefers-color-scheme: dark)" # Dark mode
  25. scheme: slate
  26. accent: indigo
  27. toggle:
  28. icon: material/lightbulb
  29. name: Switch to light mode
  30. features:
  31. - search.suggest
  32. - search.highlight
  33. - search.share
  34. - navigation.sections
  35. - toc.integrate
  36. - content.tabs.link
  37. extra:
  38. homepage: /
  39. social:
  40. - icon: fontawesome/brands/github-alt
  41. link: https://github.com/binwiederhier
  42. extra_javascript:
  43. - static/js/extra.js
  44. extra_css:
  45. - static/css/extra.css
  46. markdown_extensions:
  47. - admonition
  48. - meta
  49. - toc:
  50. permalink: true
  51. - pymdownx.tabbed:
  52. alternate_style: true
  53. - pymdownx.superfences
  54. - pymdownx.highlight:
  55. extend_pygments_lang:
  56. - name: php-inline
  57. lang: php
  58. options:
  59. startinline: true
  60. - pymdownx.tasklist:
  61. custom_checkbox: true
  62. - attr_list
  63. - md_in_html
  64. - pymdownx.emoji:
  65. emoji_index: !!python/name:material.extensions.emoji.twemoji
  66. emoji_generator: !!python/name:material.extensions.emoji.to_svg
  67. hooks:
  68. - docs/hooks.py
  69. plugins:
  70. - search
  71. - minify:
  72. minify_html: true
  73. nav:
  74. - "Getting started": index.md
  75. - "Publishing":
  76. - "Sending messages": publish.md
  77. - "Subscribing":
  78. - "From your phone": subscribe/phone.md
  79. - "From the Web app": subscribe/web.md
  80. - "From the Desktop": subscribe/pwa.md
  81. - "From the CLI": subscribe/cli.md
  82. - "Using the API": subscribe/api.md
  83. - "Self-hosting":
  84. - "Installation": install.md
  85. - "Configuration": config.md
  86. - "Other things":
  87. - "FAQs": faq.md
  88. - "Examples": examples.md
  89. - "Integrations + projects": integrations.md
  90. - "Release notes": releases.md
  91. - "Emojis 🥳 🎉": emojis.md
  92. - "Troubleshooting": troubleshooting.md
  93. - "Known issues": known-issues.md
  94. - "Deprecation notices": deprecations.md
  95. - "Development": develop.md
  96. - "Privacy policy": privacy.md