Move docs into subdirectory to make mkdocs work in a subdirectory

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-04 13:07:44 +01:00
parent d52d1d255a
commit eaeb88401d
94 changed files with 62 additions and 45 deletions
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -0,0 +1,61 @@
+site_name: HedgeDoc
+site_url: https://docs.hedgedoc.org
+repo_url: https://github.com/hedgedoc/hedgedoc
+site_description: 'HedgeDoc Documentation'
+site_author: 'HedgeDoc Developers'
+docs_dir: content
+nav:
+  - Home: index.md
+  - Installation:
+      - 'Manual Installation': setup/manual-setup.md
+      - 'Reverse Proxy': setup/reverse-proxy.md
+      - Docker: setup/docker.md
+      - Cloudron: setup/cloudron.md
+      - Heroku: setup/heroku.md
+      - LinuxServer: setup/docker-linuxserver.md
+      - Yunohost: setup/yunohost.md
+  - Guides:
+      - Authentication:
+          - LDAP: guides/auth/ldap-ad.md
+          - OAuth: guides/auth/oauth.md
+          - SAML : guides/auth/saml.md
+          - SAML Keycloak : guides/auth/saml-keycloak.md
+          - SAML Onelogin : guides/auth/saml-onelogin.md
+          - GitHub: guides/auth/github.md
+          - GitLab: guides/auth/gitlab-self-hosted.md
+          - Keycloak: guides/auth/keycloak.md
+          - NextCloud: guides/auth/nextcloud.md
+          - Twitter: guides/auth/twitter.md
+      - Migrate from Etherpad: guides/migrate-etherpad.md
+      - Breaking Changes: guides/migrations-and-breaking-changes.md
+      - Media Backend:
+          - Minion: guides/minio-image-upload.md
+          - S3: guides/s3-image-upload.md
+      - Setting Terms: guides/providing-terms.md
+  - Configuration: configuration.md
+  - Developer:
+      - 'Getting Started': dev/getting-started.md
+      - API: dev/api.md
+      - 'Operational Transformation': dev/ot.md
+      - Webpack: dev/webpack.md
+      - 'Documentation': dev/documentation.md
+  - FAQ: https://hedgedoc.org/faq
+markdown_extensions:
+  - toc:
+      permalink: true
+theme:
+  name: 'material'
+  language: en
+  favicon: images/favicon.png
+  logo: images/logo.svg
+  palette:
+    scheme: light
+    primary: 'hedgedoc'
+    accent: 'hedgedoc'
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+
+extra_css:
+  - theme/styles/hedgedoc-color.css