]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - mkdocs.yml
Disable MkDocs' strict mode for ReadTheDocs builds to pass
[github/shaarli/Shaarli.git] / mkdocs.yml
CommitLineData
53ed6d7d 1site_name: Shaarli Documentation
2repo_url: https://github.com/shaarli/Shaarli
1093ddee 3edit_uri: edit/master/doc/md
53ed6d7d 4site_description: The personal, minimalist, super-fast, database free, bookmarking service
5theme: readthedocs
6docs_dir: doc/md
7site_dir: doc/html
9618e45f
V
8# Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings:
9# - https://github.com/shaarli/Shaarli/issues/1179
10# - https://github.com/rtfd/readthedocs.org/issues/4314
11# strict: true
53ed6d7d 12
13pages:
14- Home: index.md
15- Setup:
16 - Download and Installation: Download-and-Installation.md
17 - Upgrade and migration: Upgrade-and-migration.md
53ed6d7d 18 - Server configuration: Server-configuration.md
19 - Server security: Server-security.md
20 - Shaarli configuration: Shaarli-configuration.md
21 - Plugins: Plugins.md
22- Docker:
84d0632a
V
23 - Docker 101: docker/docker-101.md
24 - Shaarli images: docker/shaarli-images.md
25 - Reverse proxy configuration: docker/reverse-proxy-configuration.md
26 - Docker resources: docker/resources.md
53ed6d7d 27- Usage:
53ed6d7d 28 - Browsing and searching: Browsing-and-searching.md
80786e15 29 - Sharing content: Sharing-content.md
972cd800 30 - RSS feeds: RSS-feeds.md
53ed6d7d 31 - REST API: REST-API.md
e2a2dc35 32 - Community & Related software: Community-&-Related-software.md
53ed6d7d 33- How To:
34 - Backup, restore, import and export: Backup,-restore,-import-and-export.md
460ce501 35 - Various hacks: Various-hacks.md
53ed6d7d 36- Development:
37 - Development guidelines: Development-guidelines.md
38 - Continuous integration tools: Continuous-integration-tools.md
39 - GnuPG signature: GnuPG-signature.md
53ed6d7d 40 - Directory structure: Directory-structure.md
41 - 3rd party libraries: 3rd-party-libraries.md
42 - Plugin System: Plugin-System.md
43 - Release Shaarli: Release-Shaarli.md
44 - Versioning and Branches: Versioning-and-Branches.md
45 - Security: Security.md
46 - Static analysis: Static-analysis.md
1a47014f 47 - Translations: Translations.md
53ed6d7d 48 - Theming: Theming.md
49 - Unit tests: Unit-tests.md
d6916040 50 - Unit tests inside Docker: Unit-tests-Docker.md
e2a2dc35 51- FAQ: FAQ.md
52- Troubleshooting: Troubleshooting.md