]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - mkdocs.yml
Provide a Docker Compose example
[github/shaarli/Shaarli.git] / mkdocs.yml
index d6dd3fc275bc8bfbfdcd0b7a9a419504b35a033c..a1226e8fb19e2066b3d503e3274b415bdae41fb7 100644 (file)
@@ -1,41 +1,39 @@
 site_name: Shaarli Documentation
 repo_url: https://github.com/shaarli/Shaarli
+edit_uri: edit/master/doc/md
 site_description: The personal, minimalist, super-fast, database free, bookmarking service
 theme: readthedocs
 docs_dir: doc/md
 site_dir: doc/html
+strict: true
 
 pages:
 - Home: index.md
 - Setup:
     - Download and Installation: Download-and-Installation.md
     - Upgrade and migration: Upgrade-and-migration.md
-    - Server requirements: Server-requirements.md
     - Server configuration: Server-configuration.md
     - Server security: Server-security.md
     - Shaarli configuration: Shaarli-configuration.md
     - Plugins: Plugins.md
 - Docker:
-    - Docker 101: Docker-101.md
-    - Shaarli images: Shaarli-images.md
-    - Reverse proxy configuration: Reverse-proxy-configuration.md
-    - Docker resources: Docker-resources.md
+    - Docker 101: docker/docker-101.md
+    - Shaarli images: docker/shaarli-images.md
+    - Reverse proxy configuration: docker/reverse-proxy-configuration.md
+    - Docker resources: docker/resources.md
 - Usage:
-    - Features: Features.md
-    - Bookmarklet: Bookmarklet.md
     - Browsing and searching: Browsing-and-searching.md
-    - Firefox share: Firefox-share.md
-    - RSS feeds: RSS-feeds.md 
+    - Sharing content: Sharing-content.md
+    - RSS feeds: RSS-feeds.md
     - REST API: REST-API.md
+    - Community & Related software: Community-&-Related-software.md
 - How To:
     - Backup, restore, import and export: Backup,-restore,-import-and-export.md
     - Various hacks: Various-hacks.md
-- Troubleshooting: Troubleshooting.md
 - Development:
     - Development guidelines: Development-guidelines.md
     - Continuous integration tools: Continuous-integration-tools.md
     - GnuPG signature: GnuPG-signature.md
-    - Coding guidelines: Coding-guidelines.md
     - Directory structure: Directory-structure.md
     - 3rd party libraries: 3rd-party-libraries.md
     - Plugin System: Plugin-System.md
@@ -43,8 +41,9 @@ pages:
     - Versioning and Branches: Versioning-and-Branches.md
     - Security: Security.md
     - Static analysis: Static-analysis.md
+    - Translations: Translations.md
     - Theming: Theming.md
     - Unit tests: Unit-tests.md
-- About:
-    - FAQ: FAQ.md
-    - Community & Related software: Community-&-Related-software.md
+    - Unit tests inside Docker: Unit-tests-Docker.md
+- FAQ: FAQ.md
+- Troubleshooting: Troubleshooting.md