summaryrefslogtreecommitdiff
path: root/docs/mkdocs.yml
diff options
context:
space:
mode:
authorTilman Vatteroth2021-01-04 13:07:44 +0100
committerTilman Vatteroth2021-01-05 13:15:32 +0100
commiteaeb88401d07687eb3db8c273f7a4c0ed31ec153 (patch)
treec05c4f17da9ce1cd0aa603febc6a14b2410e6a5e /docs/mkdocs.yml
parentd52d1d255a876fcf937c9df3717f6df9b745ad22 (diff)
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Diffstat (limited to 'docs/mkdocs.yml')
-rw-r--r--docs/mkdocs.yml61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
new file mode 100644
index 00000000..a403cd3b
--- /dev/null
+++ 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