aboutsummaryrefslogtreecommitdiffhomepage
path: root/mkdocs.yml
diff options
context:
space:
mode:
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml53
1 files changed, 53 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 00000000..f9648a7e
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,53 @@
1site_name: Shaarli Documentation
2repo_url: https://github.com/shaarli/Shaarli
3site_description: The personal, minimalist, super-fast, database free, bookmarking service
4theme: readthedocs
5docs_dir: doc/md
6site_dir: doc/html
7
8pages:
9- Home: index.md
10- Setup:
11 - Download and Installation: Download-and-Installation.md
12 - Upgrade and migration: Upgrade-and-migration.md
13 - Server requirements: Server-requirements.md
14 - Server configuration: Server-configuration.md
15 - Server security: Server-security.md
16 - Shaarli configuration: Shaarli-configuration.md
17 - Plugins: Plugins.md
18- Docker:
19 - Docker 101: Docker-101.md
20 - Shaarli images: Shaarli-images.md
21 - Reverse proxy configuration: Reverse-proxy-configuration.md
22 - Docker resources: Docker-resources.md
23- Usage:
24 - Features: Features.md
25 - Bookmarklet: Bookmarklet.md
26 - Browsing and searching: Browsing-and-searching.md
27 - Firefox share: Firefox-share.md
28 - RSS feeds: RSS-feeds.md
29 - REST API: REST-API.md
30- How To:
31 - Backup, restore, import and export: Backup,-restore,-import-and-export.md
32 - Copy an existing installation over SSH and serve it locally: Copy-an-existing-installation-over-SSH-and-serve-it-locally.md
33 - Create and serve multiple Shaarlis (farm): Create-and-serve-multiple-Shaarlis-(farm).md
34 - Download CSS styles from an OPML list: Download-CSS-styles-from-an-OPML-list.md
35 - Datastore hacks: Datastore-hacks.md
36- Troubleshooting: Troubleshooting.md
37- Development:
38 - Development guidelines: Development-guidelines.md
39 - Continuous integration tools: Continuous-integration-tools.md
40 - GnuPG signature: GnuPG-signature.md
41 - Coding guidelines: Coding-guidelines.md
42 - Directory structure: Directory-structure.md
43 - 3rd party libraries: 3rd-party-libraries.md
44 - Plugin System: Plugin-System.md
45 - Release Shaarli: Release-Shaarli.md
46 - Versioning and Branches: Versioning-and-Branches.md
47 - Security: Security.md
48 - Static analysis: Static-analysis.md
49 - Theming: Theming.md
50 - Unit tests: Unit-tests.md
51- About:
52 - FAQ: FAQ.md
53 - Community & Related software: Community-&-Related-software.md