aboutsummaryrefslogtreecommitdiffhomepage
path: root/mkdocs.yml
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-07-04 21:37:30 +0200
committerGitHub <noreply@github.com>2017-07-04 21:37:30 +0200
commit5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch)
treed5c46525f3c739d9c63de860427e0b3cadd688e5 /mkdocs.yml
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
parent8bf94136e10c64496711c8f66a4f58f89c515360 (diff)
downloadShaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst
Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml50
1 files changed, 50 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 00000000..d6dd3fc2
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,50 @@
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 - Various hacks: Various-hacks.md
33- Troubleshooting: Troubleshooting.md
34- Development:
35 - Development guidelines: Development-guidelines.md
36 - Continuous integration tools: Continuous-integration-tools.md
37 - GnuPG signature: GnuPG-signature.md
38 - Coding guidelines: Coding-guidelines.md
39 - Directory structure: Directory-structure.md
40 - 3rd party libraries: 3rd-party-libraries.md
41 - Plugin System: Plugin-System.md
42 - Release Shaarli: Release-Shaarli.md
43 - Versioning and Branches: Versioning-and-Branches.md
44 - Security: Security.md
45 - Static analysis: Static-analysis.md
46 - Theming: Theming.md
47 - Unit tests: Unit-tests.md
48- About:
49 - FAQ: FAQ.md
50 - Community & Related software: Community-&-Related-software.md