summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Molares2021-01-03 16:00:25 +0100
committerPhilip Molares2021-01-03 16:00:25 +0100
commit55d653a1a2046dcc90f675c75e0a2aa4164e6a86 (patch)
tree3c7bd316c2326ead81b137a6e46f92f020594730
parent5b3d62e494c52309765da4b420516f00d49cb753 (diff)
started work on a mkdocs documentation for readthedocs.org
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Diffstat (limited to '')
-rw-r--r--docs/guides/index.md3
-rw-r--r--docs/index.md7
-rw-r--r--mkdocs.yml38
3 files changed, 48 insertions, 0 deletions
diff --git a/docs/guides/index.md b/docs/guides/index.md
new file mode 100644
index 00000000..25d4d949
--- /dev/null
+++ b/docs/guides/index.md
@@ -0,0 +1,3 @@
+## Guides
+
+In this section we try to provide you with some step-by-step guides for common scenarios to configure HedgeDoc to your needs.
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 00000000..e00a1d10
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,7 @@
+# Welcome to the HedgeDoc Documentation
+
+This page should help you host and configure your own HedgeDoc instance.
+
+We provide:
+- [Guides for common scenarios](guides/index.md)
+
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 00000000..dfe74d43
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,38 @@
+site_name: HedgeDoc
+site_url: https://docs.hedgedoc.org
+nav:
+ - Home: index.md
+ - Setup:
+ - 'Manual Installation': setup/manual-setup.md
+ - 'Reverse Proxy': setup/reverse-proxy.md
+ - Docker: setup/docker.md
+ - Kubernetes: setup/kubernetes.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:
+ - API: dev/api.md
+ - 'Developer Notes': dev/getting-started.md
+ - 'Operational Transformation': dev/ot.md
+ - Webpack: dev/webpack.md
+theme: readthedocs