mkdocs.yml 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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. language: en
  12. logo: static/img/ntfy.png
  13. favicon: static/img/favicon.png
  14. include_search_page: false
  15. search_index_only: true
  16. palette:
  17. - media: "(prefers-color-scheme: light)" # Light mode
  18. scheme: default
  19. toggle:
  20. icon: material/lightbulb-outline
  21. name: Switch to dark mode
  22. - media: "(prefers-color-scheme: dark)" # Dark mode
  23. scheme: slate
  24. accent: indigo
  25. toggle:
  26. icon: material/lightbulb
  27. name: Switch to light mode
  28. features:
  29. - search.suggest
  30. - search.highlight
  31. - search.share
  32. - navigation.sections
  33. - toc.integrate
  34. - content.tabs.link
  35. extra:
  36. homepage: /
  37. social:
  38. - icon: fontawesome/brands/github-alt
  39. link: https://github.com/binwiederhier
  40. extra_javascript:
  41. - static/js/extra.js
  42. extra_css:
  43. - static/css/extra.css
  44. markdown_extensions:
  45. - admonition
  46. - meta
  47. - toc:
  48. permalink: true
  49. - pymdownx.tabbed:
  50. alternate_style: true
  51. - pymdownx.superfences
  52. - pymdownx.highlight:
  53. extend_pygments_lang:
  54. - name: php-inline
  55. lang: php
  56. options:
  57. startinline: true
  58. - pymdownx.tasklist:
  59. custom_checkbox: true
  60. - attr_list
  61. - md_in_html
  62. - pymdownx.emoji:
  63. emoji_index: !!python/name:materialx.emoji.twemoji
  64. emoji_generator: !!python/name:materialx.emoji.to_svg
  65. plugins:
  66. - search
  67. - minify:
  68. minify_html: true
  69. nav:
  70. - "Getting started": index.md
  71. - "Publishing":
  72. - "Sending messages": publish.md
  73. - "Subscribing":
  74. - "From your phone": subscribe/phone.md
  75. - "From the Web UI": subscribe/web.md
  76. - "From the CLI": subscribe/cli.md
  77. - "Using the API": subscribe/api.md
  78. - "Self-hosting":
  79. - "Installation": install.md
  80. - "Configuration": config.md
  81. - "Other things":
  82. - "FAQs": faq.md
  83. - "Examples": examples.md
  84. - "Integrations + projects": integrations.md
  85. - "Release notes": releases.md
  86. - "Deprecation notices": deprecations.md
  87. - "Emojis 🥳 🎉": emojis.md
  88. - "Development": develop.md
  89. - "Privacy policy": privacy.md