X-Git-Url: https://git.immae.eu/?p=github%2Fshaarli%2FShaarli.git;a=blobdiff_plain;f=mkdocs.yml;h=248fdbfe3923dafab6cca711a4f4278eaf6a583b;hp=59faf11c968f5836a9b35d92dbacfb3f3ad3d1b0;hb=HEAD;hpb=286757ab29660916f6b66d1fc0ad3b53aef337c8 diff --git a/mkdocs.yml b/mkdocs.yml index 59faf11c..2e201d03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,50 +2,38 @@ 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 +theme: + name: readthedocs + custom_dir: doc/custom_theme/ docs_dir: doc/md site_dir: doc/html +# Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings: +# - https://github.com/shaarli/Shaarli/issues/1179 +# - https://github.com/rtfd/readthedocs.org/issues/4314 +# 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 + - Installation: Installation.md + - Docker: Docker.md + - Reverse Proxy: Reverse-proxy.md + - Backup and restore: Backup-and-restore.md - Shaarli configuration: Shaarli-configuration.md - Plugins: Plugins.md -- Docker: - - 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 + - Upgrade and migration: Upgrade-and-migration.md - Usage: - - Bookmarklet: Bookmarklet.md - - Browsing and searching: Browsing-and-searching.md - - Firefox share: Firefox-share.md - - RSS feeds: RSS-feeds.md + - Usage: Usage.md - REST API: REST-API.md -- How To: - - Backup, restore, import and export: Backup,-restore,-import-and-export.md - - Various hacks: Various-hacks.md -- Troubleshooting: Troubleshooting.md + - Community and Related software: Community-and-related-software.md - Development: - - Development guidelines: Development-guidelines.md - - Continuous integration tools: Continuous-integration-tools.md - - GnuPG signature: GnuPG-signature.md - - Directory structure: Directory-structure.md - - 3rd party libraries: 3rd-party-libraries.md - - Plugin System: Plugin-System.md - - Release Shaarli: Release-Shaarli.md - - 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 - - Unit tests inside Docker: Unit-tests-Docker.md -- About: - - FAQ: FAQ.md - - Community & Related software: Community-&-Related-software.md + - Development: dev/Development.md + - Versioning: dev/Versioning.md + - GnuPG signature: dev/GnuPG-signature.md + - Plugin System: dev/Plugin-system.md + - Translations: dev/Translations.md + - Release Shaarli: dev/Release-Shaarli.md + - Theming: dev/Theming.md + - Unit tests: dev/Unit-tests.md +- Troubleshooting: Troubleshooting.md