]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - mkdocs.yml
Merge pull request #1234 from virtualtam/lint
[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
2b4f3915 5theme:
6 name: readthedocs
7 custom_dir: doc/custom_theme/
53ed6d7d 8docs_dir: doc/md
9site_dir: doc/html
9618e45f
V
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
53ed6d7d 14
15pages:
16- Home: index.md
17- Setup:
18 - Download and Installation: Download-and-Installation.md
19 - Upgrade and migration: Upgrade-and-migration.md
53ed6d7d 20 - Server configuration: Server-configuration.md
21 - Server security: Server-security.md
22 - Shaarli configuration: Shaarli-configuration.md
23 - Plugins: Plugins.md
24- Docker:
84d0632a
V
25 - Docker 101: docker/docker-101.md
26 - Shaarli images: docker/shaarli-images.md
27 - Reverse proxy configuration: docker/reverse-proxy-configuration.md
28 - Docker resources: docker/resources.md
53ed6d7d 29- Usage:
53ed6d7d 30 - Browsing and searching: Browsing-and-searching.md
80786e15 31 - Sharing content: Sharing-content.md
972cd800 32 - RSS feeds: RSS-feeds.md
53ed6d7d 33 - REST API: REST-API.md
e2a2dc35 34 - Community & Related software: Community-&-Related-software.md
1cafacfe 35- Guides:
a0c34a49 36 - Install Shaarli on Debian 9 with Docker: guides/install-shaarli-with-debian9-and-docker.md
1cafacfe
V
37 - Backup, restore, import and export: guides/backup-restore-import-export.md
38 - Various hacks: guides/various-hacks.md
53ed6d7d 39- Development:
40 - Development guidelines: Development-guidelines.md
41 - Continuous integration tools: Continuous-integration-tools.md
42 - GnuPG signature: GnuPG-signature.md
53ed6d7d 43 - Directory structure: Directory-structure.md
8b5b7dcc 44 - Link Structure: Link-structure.md
53ed6d7d 45 - 3rd party libraries: 3rd-party-libraries.md
46 - Plugin System: Plugin-System.md
47 - Release Shaarli: Release-Shaarli.md
48 - Versioning and Branches: Versioning-and-Branches.md
49 - Security: Security.md
50 - Static analysis: Static-analysis.md
1a47014f 51 - Translations: Translations.md
53ed6d7d 52 - Theming: Theming.md
53 - Unit tests: Unit-tests.md
d6916040 54 - Unit tests inside Docker: Unit-tests-Docker.md
e2a2dc35 55- FAQ: FAQ.md
56- Troubleshooting: Troubleshooting.md