mkdocs.yml 2.4 KB

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