mkdocs.yml

   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
  15 pages:
  16 - Home: index.md
  17 - Setup:
  18     - Server configuration: Server-configuration.md
  19     - Installation: Installation.md
  20     - Docker: Docker.md
  21     - Reverse Proxy: Reverse-proxy.md
  22     - Backup and restore: Backup-and-restore.md
  23     - Shaarli configuration: Shaarli-configuration.md
  24     - Plugins: Plugins.md
  25     - Upgrade and migration: Upgrade-and-migration.md
  26 - Usage:
  27     - Usage: Usage.md
  28     - REST API: REST-API.md
  29     - Community and Related software: Community-and-related-software.md
  30 - Development:
  31     - Development: dev/Development.md
  32     - Versioning: dev/Versioning.md
  33     - GnuPG signature: dev/GnuPG-signature.md
  34     - Plugin System: dev/Plugin-system.md
  35     - Translations: dev/Translations.md
  36     - Release Shaarli: dev/Release-Shaarli.md
  37     - Theming: dev/Theming.md
  38     - Unit tests: dev/Unit-tests.md
  39 - Troubleshooting: Troubleshooting.md