mkdocs.yml 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. site_dir: server/docs
  2. site_name: ntfy
  3. site_url: https://ntfy.sh
  4. site_description: simple HTTP-based pub-sub
  5. copyright: Made with ❤️ by Philipp C. Heckel
  6. repo_name: binwiederhier/ntfy
  7. repo_url: https://github.com/binwiederhier/ntfy
  8. edit_uri: edit/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. # - navigation.instant
  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. plugins:
  64. - search
  65. - minify:
  66. minify_html: true
  67. nav:
  68. - "Getting started": index.md
  69. - "Publishing":
  70. - "Sending messages": publish.md
  71. - "Subscribing":
  72. - "From your phone": subscribe/phone.md
  73. - "From the Web UI": subscribe/web.md
  74. - "Using the API": subscribe/api.md
  75. - "Self-hosting":
  76. - "Installation": install.md
  77. - "Configuration": config.md
  78. - "Other things":
  79. - "FAQs": faq.md
  80. - "Examples": examples.md
  81. - "Emojis 🥳 🎉": emojis.md
  82. - "Development": develop.md
  83. - "Privacy policy": privacy.md