mkdocs.yml 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. site_name: Shaarli Documentation
  2. repo_url: https://github.com/shaarli/Shaarli
  3. edit_uri: edit/master/doc/md
  4. site_description: The personal, minimalist, super-fast, database free, bookmarking service
  5. theme:
  6. name: readthedocs
  7. custom_dir: doc/custom_theme/
  8. docs_dir: doc/md
  9. site_dir: doc/html
  10. # Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings:
  11. # - https://github.com/shaarli/Shaarli/issues/1179
  12. # - https://github.com/rtfd/readthedocs.org/issues/4314
  13. # strict: true
  14. nav:
  15. - Home: index.md
  16. - Setup:
  17. - Server configuration: Server-configuration.md
  18. - Installation: Installation.md
  19. - Docker: Docker.md
  20. - Reverse Proxy: Reverse-proxy.md
  21. - Backup and restore: Backup-and-restore.md
  22. - Shaarli configuration: Shaarli-configuration.md
  23. - Plugins: Plugins.md
  24. - Upgrade and migration: Upgrade-and-migration.md
  25. - Usage:
  26. - Usage: Usage.md
  27. - REST API: REST-API.md
  28. - Community and Related software: Community-and-related-software.md
  29. - Development:
  30. - Development: dev/Development.md
  31. - Versioning: dev/Versioning.md
  32. - GnuPG signature: dev/GnuPG-signature.md
  33. - Plugin System: dev/Plugin-system.md
  34. - Translations: dev/Translations.md
  35. - Release Shaarli: dev/Release-Shaarli.md
  36. - Theming: dev/Theming.md
  37. - Unit tests: dev/Unit-tests.md
  38. - Troubleshooting: Troubleshooting.md
  39. markdown_extensions:
  40. - toc:
  41. permalink: "#"