summaryrefslogtreecommitdiff
path: root/docs
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
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')
-rw-r--r--docs/content/configuration.md (renamed from docs/configuration.md)4
-rw-r--r--docs/content/dev/api.md (renamed from docs/dev/api.md)4
-rw-r--r--docs/content/dev/documentation.md27
-rw-r--r--docs/content/dev/getting-started.md (renamed from docs/dev/getting-started.md)4
-rw-r--r--docs/content/dev/openapi.yml (renamed from docs/dev/openapi.yml)0
-rw-r--r--docs/content/dev/ot.md (renamed from docs/dev/ot.md)0
-rw-r--r--docs/content/dev/webpack.md (renamed from docs/dev/webpack.md)0
-rw-r--r--docs/content/guides/auth/github.md (renamed from docs/guides/auth/github.md)0
-rw-r--r--docs/content/guides/auth/gitlab-self-hosted.md (renamed from docs/guides/auth/gitlab-self-hosted.md)0
-rw-r--r--docs/content/guides/auth/keycloak.md (renamed from docs/guides/auth/keycloak.md)0
-rw-r--r--docs/content/guides/auth/ldap-ad.md (renamed from docs/guides/auth/ldap-ad.md)0
-rw-r--r--docs/content/guides/auth/mattermost-self-hosted.md (renamed from docs/guides/auth/mattermost-self-hosted.md)0
-rw-r--r--docs/content/guides/auth/nextcloud.md (renamed from docs/guides/auth/nextcloud.md)0
-rw-r--r--docs/content/guides/auth/oauth.md (renamed from docs/guides/auth/oauth.md)0
-rw-r--r--docs/content/guides/auth/saml-keycloak.md (renamed from docs/guides/auth/saml-keycloak.md)0
-rw-r--r--docs/content/guides/auth/saml-onelogin.md (renamed from docs/guides/auth/saml-onelogin.md)0
-rw-r--r--docs/content/guides/auth/saml.md (renamed from docs/guides/auth/saml.md)0
-rw-r--r--docs/content/guides/auth/twitter.md (renamed from docs/guides/auth/twitter.md)0
-rw-r--r--docs/content/guides/migrate-etherpad.md (renamed from docs/guides/migrate-etherpad.md)0
-rw-r--r--docs/content/guides/migrations-and-breaking-changes.md (renamed from docs/guides/migrations-and-breaking-changes.md)0
-rw-r--r--docs/content/guides/minio-image-upload.md (renamed from docs/guides/minio-image-upload.md)0
-rw-r--r--docs/content/guides/providing-terms.md (renamed from docs/guides/providing-terms.md)0
-rw-r--r--docs/content/guides/s3-image-upload.md (renamed from docs/guides/s3-image-upload.md)2
-rw-r--r--docs/content/history.md (renamed from docs/history.md)0
-rw-r--r--docs/content/images/auth/application-page.png (renamed from docs/images/auth/application-page.png)bin115400 -> 115400 bytes
-rw-r--r--docs/content/images/auth/create-oauth-app.png (renamed from docs/images/auth/create-oauth-app.png)bin40088 -> 40088 bytes
-rw-r--r--docs/content/images/auth/create-twitter-app.png (renamed from docs/images/auth/create-twitter-app.png)bin115406 -> 115406 bytes
-rw-r--r--docs/content/images/auth/gitlab-application-details.png (renamed from docs/images/auth/gitlab-application-details.png)bin30378 -> 30378 bytes
-rw-r--r--docs/content/images/auth/gitlab-new-application.png (renamed from docs/images/auth/gitlab-new-application.png)bin45457 -> 45457 bytes
-rw-r--r--docs/content/images/auth/gitlab-sign-in.png (renamed from docs/images/auth/gitlab-sign-in.png)bin5590 -> 5590 bytes
-rw-r--r--docs/content/images/auth/keycloak_add_client.png (renamed from docs/images/auth/keycloak_add_client.png)bin54087 -> 54087 bytes
-rw-r--r--docs/content/images/auth/keycloak_client_overview.png (renamed from docs/images/auth/keycloak_client_overview.png)bin207910 -> 207910 bytes
-rw-r--r--docs/content/images/auth/keycloak_clients_overview.png (renamed from docs/images/auth/keycloak_clients_overview.png)bin78485 -> 78485 bytes
-rw-r--r--docs/content/images/auth/keycloak_force_idformat.png (renamed from docs/images/auth/keycloak_force_idformat.png)bin6092 -> 6092 bytes
-rw-r--r--docs/content/images/auth/keycloak_idp_cert.png (renamed from docs/images/auth/keycloak_idp_cert.png)bin75137 -> 75137 bytes
-rw-r--r--docs/content/images/auth/keycloak_mapper_email.png (renamed from docs/images/auth/keycloak_mapper_email.png)bin52782 -> 52782 bytes
-rw-r--r--docs/content/images/auth/keycloak_mapper_overview.png (renamed from docs/images/auth/keycloak_mapper_overview.png)bin30320 -> 30320 bytes
-rw-r--r--docs/content/images/auth/keycloak_mapper_username.png (renamed from docs/images/auth/keycloak_mapper_username.png)bin55010 -> 55010 bytes
-rw-r--r--docs/content/images/auth/keycloak_saml_export_cert.png (renamed from docs/images/auth/keycloak_saml_export_cert.png)bin181200 -> 181200 bytes
-rw-r--r--docs/content/images/auth/keycloak_saml_export_cert_details.png (renamed from docs/images/auth/keycloak_saml_export_cert_details.png)bin23261 -> 23261 bytes
-rw-r--r--docs/content/images/auth/keycloak_saml_import_cert.png (renamed from docs/images/auth/keycloak_saml_import_cert.png)bin181214 -> 181214 bytes
-rw-r--r--docs/content/images/auth/keycloak_saml_import_cert_details.png (renamed from docs/images/auth/keycloak_saml_import_cert_details.png)bin48727 -> 48727 bytes
-rw-r--r--docs/content/images/auth/mattermost-enable-oauth2.png (renamed from docs/images/auth/mattermost-enable-oauth2.png)bin26034 -> 26034 bytes
-rw-r--r--docs/content/images/auth/mattermost-oauth-app-add.png (renamed from docs/images/auth/mattermost-oauth-app-add.png)bin21443 -> 21443 bytes
-rw-r--r--docs/content/images/auth/mattermost-oauth-app-done.png (renamed from docs/images/auth/mattermost-oauth-app-done.png)bin31767 -> 31767 bytes
-rw-r--r--docs/content/images/auth/mattermost-oauth-app-form.png (renamed from docs/images/auth/mattermost-oauth-app-form.png)bin62160 -> 62160 bytes
-rw-r--r--docs/content/images/auth/nextcloud-oauth2-1-settings.png (renamed from docs/images/auth/nextcloud-oauth2-1-settings.png)bin47047 -> 47047 bytes
-rw-r--r--docs/content/images/auth/nextcloud-oauth2-2-client-add.png (renamed from docs/images/auth/nextcloud-oauth2-2-client-add.png)bin11684 -> 11684 bytes
-rw-r--r--docs/content/images/auth/nextcloud-oauth2-3-clientid-secret.png (renamed from docs/images/auth/nextcloud-oauth2-3-clientid-secret.png)bin13428 -> 13428 bytes
-rw-r--r--docs/content/images/auth/onelogin-add-app.png (renamed from docs/images/auth/onelogin-add-app.png)bin40519 -> 40519 bytes
-rw-r--r--docs/content/images/auth/onelogin-copy-idp-metadata.png (renamed from docs/images/auth/onelogin-copy-idp-metadata.png)bin239493 -> 239493 bytes
-rw-r--r--docs/content/images/auth/onelogin-edit-app-name.png (renamed from docs/images/auth/onelogin-edit-app-name.png)bin122369 -> 122369 bytes
-rw-r--r--docs/content/images/auth/onelogin-edit-sp-metadata.png (renamed from docs/images/auth/onelogin-edit-sp-metadata.png)bin184470 -> 184470 bytes
-rw-r--r--docs/content/images/auth/onelogin-select-template.png (renamed from docs/images/auth/onelogin-select-template.png)bin73244 -> 73244 bytes
-rw-r--r--docs/content/images/auth/onelogin-use-dashboard.png (renamed from docs/images/auth/onelogin-use-dashboard.png)bin27216 -> 27216 bytes
-rw-r--r--docs/content/images/auth/register-oauth-application-form.png (renamed from docs/images/auth/register-oauth-application-form.png)bin117289 -> 117289 bytes
-rw-r--r--docs/content/images/auth/register-twitter-application.png (renamed from docs/images/auth/register-twitter-application.png)bin202414 -> 202414 bytes
-rw-r--r--docs/content/images/auth/twitter-app-confirmation.png (renamed from docs/images/auth/twitter-app-confirmation.png)bin191064 -> 191064 bytes
-rw-r--r--docs/content/images/auth/twitter-app-keys.png (renamed from docs/images/auth/twitter-app-keys.png)bin162703 -> 162703 bytes
-rw-r--r--docs/content/images/favicon.pngbin0 -> 605 bytes
-rw-r--r--docs/content/images/hedgedoc_logo_horizontal.svg1
-rw-r--r--docs/content/images/logo.svg1
-rw-r--r--docs/content/images/minio-image-upload/create-bucket.png (renamed from docs/images/minio-image-upload/create-bucket.png)bin15207 -> 15207 bytes
-rw-r--r--docs/content/images/minio-image-upload/create-policy.png (renamed from docs/images/minio-image-upload/create-policy.png)bin21156 -> 21156 bytes
-rw-r--r--docs/content/images/minio-image-upload/default-view.png (renamed from docs/images/minio-image-upload/default-view.png)bin13061 -> 13061 bytes
-rw-r--r--docs/content/images/minio-image-upload/docker-logs.png (renamed from docs/images/minio-image-upload/docker-logs.png)bin73263 -> 73263 bytes
-rw-r--r--docs/content/images/minio-image-upload/open-edit-policy.png (renamed from docs/images/minio-image-upload/open-edit-policy.png)bin17514 -> 17514 bytes
-rw-r--r--docs/content/images/s3-image-upload/bucket-policy-editor.png (renamed from docs/images/s3-image-upload/bucket-policy-editor.png)bin54641 -> 54641 bytes
-rw-r--r--docs/content/images/s3-image-upload/bucket-property.png (renamed from docs/images/s3-image-upload/bucket-property.png)bin71762 -> 71762 bytes
-rw-r--r--docs/content/images/s3-image-upload/create-bucket.png (renamed from docs/images/s3-image-upload/create-bucket.png)bin70260 -> 70260 bytes
-rw-r--r--docs/content/images/s3-image-upload/custom-policy.png (renamed from docs/images/s3-image-upload/custom-policy.png)bin55804 -> 55804 bytes
-rw-r--r--docs/content/images/s3-image-upload/iam-user.png (renamed from docs/images/s3-image-upload/iam-user.png)bin91526 -> 91526 bytes
-rw-r--r--docs/content/images/s3-image-upload/review-policy.png (renamed from docs/images/s3-image-upload/review-policy.png)bin100067 -> 100067 bytes
-rw-r--r--docs/content/index.md (renamed from docs/index.md)4
-rw-r--r--docs/content/legal/developer-certificate-of-origin.txt (renamed from docs/legal/developer-certificate-of-origin.txt)0
-rw-r--r--docs/content/setup/cloudron.md (renamed from docs/setup/cloudron.md)0
-rw-r--r--docs/content/setup/docker-linuxserver.md (renamed from docs/setup/docker-linuxserver.md)2
-rw-r--r--docs/content/setup/docker.md (renamed from docs/setup/docker.md)0
-rw-r--r--docs/content/setup/heroku.md (renamed from docs/setup/heroku.md)0
-rw-r--r--docs/content/setup/kubernetes.md (renamed from docs/setup/kubernetes.md)0
-rw-r--r--docs/content/setup/manual-setup.md (renamed from docs/setup/manual-setup.md)0
-rw-r--r--docs/content/setup/reverse-proxy.md (renamed from docs/setup/reverse-proxy.md)0
-rw-r--r--docs/content/setup/yunohost.md (renamed from docs/setup/yunohost.md)0
-rw-r--r--docs/content/slide-options.md (renamed from docs/slide-options.md)0
-rw-r--r--docs/content/theme/styles/hedgedoc-color.css14
-rw-r--r--docs/content/url-scheme.md (renamed from docs/url-scheme.md)0
-rw-r--r--docs/dev/documentation.md27
l---------docs/images/HedgeDoc-1.7.0-features.png1
l---------docs/images/favicon.png1
-rw-r--r--docs/images/hedgedoc_logo_horizontal.pngbin28513 -> 0 bytes
l---------docs/images/logo.png1
-rw-r--r--docs/mkdocs.yml61
-rw-r--r--docs/requirements.txt3
93 files changed, 117 insertions, 40 deletions
diff --git a/docs/configuration.md b/docs/content/configuration.md
index 438d84b3..f57d7178 100644
--- a/docs/configuration.md
+++ b/docs/content/configuration.md
@@ -4,9 +4,9 @@ You can choose to configure HedgeDoc with either a config file or with environme
Environment variables take precedence over configurations from the config files. They generally start with `CMD_` for our own options, but we also list node-specific options you can configure this way.
-- Environment variables are processed in [`lib/config/environment.js`](../lib/config/environment.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](../lib/config/default.js), in case you wonder if you even need to override it.
+- Environment variables are processed in [`lib/config/environment.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/environment.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/default.js), in case you wonder if you even need to override it.
-- The config file is processed in [`lib/config/index.js`](../lib/config/index.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](../lib/config/default.js), in case you wonder if you even need to override it. To get started, it is a good idea to take the `config.json.example` and copy it
+- The config file is processed in [`lib/config/index.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/index.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/default.js), in case you wonder if you even need to override it. To get started, it is a good idea to take the `config.json.example` and copy it
to `config.json` before filling in your own details.
**Note:** *Due to the rename process we renamed all `HMD_`-prefix variables to be `CMD_`-prefixed. The old ones continue to work.*
diff --git a/docs/dev/api.md b/docs/content/dev/api.md
index e89741d3..0700ecc3 100644
--- a/docs/dev/api.md
+++ b/docs/content/dev/api.md
@@ -11,14 +11,14 @@ You have to replace *\<NOTE\>* with either the alias or id of a note you want to
| ---------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `/new` | `GET` | **Creates a new note.**<br>A random id will be assigned and the content will equal to the template (blank by default). After note creation a redirect is issued to the created note. |
| `/new` | `POST` | **Imports some markdown data into a new note.**<br>A random id will be assigned and the content will equal to the body of the received HTTP-request. The `Content-Type: text/markdown` header should be set on this request. |
-| `/new/<ALIAS>` | `POST` | **Imports some markdown data into a new note with a given alias.**<br>This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](../configuration-env-vars.md#users-and-privileges) is enabled. |
+| `/new/<ALIAS>` | `POST` | **Imports some markdown data into a new note with a given alias.**<br>This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](../configuration.md#users-and-privileges) is enabled. |
| `/<NOTE>/download` or `/s/<SHORT-ID>/download` | `GET` | **Returns the raw markdown content of a note.** |
| `/<NOTE>/publish` | `GET` | **Redirects to the published version of the note.** |
| `/<NOTE>/slide` | `GET` | **Redirects to the slide-presentation of the note.**<br>This is only useful on notes which are designed to be slides. |
| `/<NOTE>/info` | `GET` | **Returns metadata about the note.**<br>This includes the title and description of the note as well as the creation date and viewcount. The data is returned as a JSON object. |
| `/<NOTE>/revision` | `GET` | **Returns a list of the available note revisions.**<br>The list is returned as a JSON object with an array of revision-id and length associations. The revision-id equals to the timestamp when the revision was saved. |
| `/<NOTE>/revision/<REVISION-ID>` | `GET` | **Returns the revision of the note with some metadata.**<br>The revision is returned as a JSON object with the content of the note and the authorship. |
-| `/<NOTE>/gist` | `GET` | **Creates a new GitHub Gist with the note's content.**<br>If [GitHub integration](../configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created. |
+| `/<NOTE>/gist` | `GET` | **Creates a new GitHub Gist with the note's content.**<br>If [GitHub integration](../configuration.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created. |
## User / History
These endpoints return information about the current logged-in user and it's note history. If no user is logged-in, the most of this requests will fail with either a HTTP 403 or a JSON object containing `{"status":"forbidden"}`.
diff --git a/docs/content/dev/documentation.md b/docs/content/dev/documentation.md
new file mode 100644
index 00000000..0271792b
--- /dev/null
+++ b/docs/content/dev/documentation.md
@@ -0,0 +1,27 @@
+# Documentation
+
+Our documentation is build with [mkdocs](https://www.mkdocs.org).
+
+## Writing
+
+All documentation files are found in the `docs/content` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them.
+
+The configuration for mkdocs lies in the `docs` folder in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured.
+**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website.
+
+## Building
+
+To build the documentation locally you need to perform the following steps:
+
+0. Make sure you have python3 installed.
+1. Go into the `docs` folder.
+2. Install all the dependencies (E.g. with a [venv](https://docs.python.org/3/library/venv.html)) with `pip install -r requirements.txt`
+3. Start the mkdocs dev server (`mkdocs serve`) or build the documentation (`mkdocs build`).
+
+## Deployment
+
+The documentation is deployed with [Messor Structor](https://github.com/traefik/structor).
+
+The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io.
+
+Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*`. For each branch the docs are generated separately by first installing the dependencies from `requirements.txt` and then running mkdocs. Afterwards the menu go template is used to include a version switcher in the theme.
diff --git a/docs/dev/getting-started.md b/docs/content/dev/getting-started.md
index b7787117..b7154b05 100644
--- a/docs/dev/getting-started.md
+++ b/docs/content/dev/getting-started.md
@@ -11,8 +11,8 @@
and create configs. The setup script is written in Bash, you would need bash
as a prerequisite.
-3. Setup the [config file](../configuration-config-file.md) or set up
- [environment variables](../configuration-env-vars.md).
+3. Setup the [config file](../configuration.md) or set up
+ [environment variables](../configuration.md).
## Running the Code
diff --git a/docs/dev/openapi.yml b/docs/content/dev/openapi.yml
index c5de475c..c5de475c 100644
--- a/docs/dev/openapi.yml
+++ b/docs/content/dev/openapi.yml
diff --git a/docs/dev/ot.md b/docs/content/dev/ot.md
index a1d0bebe..a1d0bebe 100644
--- a/docs/dev/ot.md
+++ b/docs/content/dev/ot.md
diff --git a/docs/dev/webpack.md b/docs/content/dev/webpack.md
index 23bbd7a1..23bbd7a1 100644
--- a/docs/dev/webpack.md
+++ b/docs/content/dev/webpack.md
diff --git a/docs/guides/auth/github.md b/docs/content/guides/auth/github.md
index f540a530..f540a530 100644
--- a/docs/guides/auth/github.md
+++ b/docs/content/guides/auth/github.md
diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md
index fc655ac5..fc655ac5 100644
--- a/docs/guides/auth/gitlab-self-hosted.md
+++ b/docs/content/guides/auth/gitlab-self-hosted.md
diff --git a/docs/guides/auth/keycloak.md b/docs/content/guides/auth/keycloak.md
index 82f6d321..82f6d321 100644
--- a/docs/guides/auth/keycloak.md
+++ b/docs/content/guides/auth/keycloak.md
diff --git a/docs/guides/auth/ldap-ad.md b/docs/content/guides/auth/ldap-ad.md
index b7d0284e..b7d0284e 100644
--- a/docs/guides/auth/ldap-ad.md
+++ b/docs/content/guides/auth/ldap-ad.md
diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/content/guides/auth/mattermost-self-hosted.md
index 2ad2afd7..2ad2afd7 100644
--- a/docs/guides/auth/mattermost-self-hosted.md
+++ b/docs/content/guides/auth/mattermost-self-hosted.md
diff --git a/docs/guides/auth/nextcloud.md b/docs/content/guides/auth/nextcloud.md
index e0eb28d1..e0eb28d1 100644
--- a/docs/guides/auth/nextcloud.md
+++ b/docs/content/guides/auth/nextcloud.md
diff --git a/docs/guides/auth/oauth.md b/docs/content/guides/auth/oauth.md
index de2ca20a..de2ca20a 100644
--- a/docs/guides/auth/oauth.md
+++ b/docs/content/guides/auth/oauth.md
diff --git a/docs/guides/auth/saml-keycloak.md b/docs/content/guides/auth/saml-keycloak.md
index 1bc3b363..1bc3b363 100644
--- a/docs/guides/auth/saml-keycloak.md
+++ b/docs/content/guides/auth/saml-keycloak.md
diff --git a/docs/guides/auth/saml-onelogin.md b/docs/content/guides/auth/saml-onelogin.md
index 8b897c82..8b897c82 100644
--- a/docs/guides/auth/saml-onelogin.md
+++ b/docs/content/guides/auth/saml-onelogin.md
diff --git a/docs/guides/auth/saml.md b/docs/content/guides/auth/saml.md
index 58a2ae45..58a2ae45 100644
--- a/docs/guides/auth/saml.md
+++ b/docs/content/guides/auth/saml.md
diff --git a/docs/guides/auth/twitter.md b/docs/content/guides/auth/twitter.md
index cbb8c865..cbb8c865 100644
--- a/docs/guides/auth/twitter.md
+++ b/docs/content/guides/auth/twitter.md
diff --git a/docs/guides/migrate-etherpad.md b/docs/content/guides/migrate-etherpad.md
index 79784ef7..79784ef7 100644
--- a/docs/guides/migrate-etherpad.md
+++ b/docs/content/guides/migrate-etherpad.md
diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/content/guides/migrations-and-breaking-changes.md
index bbc320b1..bbc320b1 100644
--- a/docs/guides/migrations-and-breaking-changes.md
+++ b/docs/content/guides/migrations-and-breaking-changes.md
diff --git a/docs/guides/minio-image-upload.md b/docs/content/guides/minio-image-upload.md
index 41d9b14e..41d9b14e 100644
--- a/docs/guides/minio-image-upload.md
+++ b/docs/content/guides/minio-image-upload.md
diff --git a/docs/guides/providing-terms.md b/docs/content/guides/providing-terms.md
index 54a792f6..54a792f6 100644
--- a/docs/guides/providing-terms.md
+++ b/docs/content/guides/providing-terms.md
diff --git a/docs/guides/s3-image-upload.md b/docs/content/guides/s3-image-upload.md
index 740dec53..3b041066 100644
--- a/docs/guides/s3-image-upload.md
+++ b/docs/content/guides/s3-image-upload.md
@@ -70,7 +70,7 @@
}
```
-9. In additional to edit `config.json` directly, you could also try [environment variables](../configuration-env-vars.md).
+9. In additional to edit `config.json` directly, you could also try [environment variables](../configuration.md).
## Related Tools
diff --git a/docs/history.md b/docs/content/history.md
index 49f40618..49f40618 100644
--- a/docs/history.md
+++ b/docs/content/history.md
diff --git a/docs/images/auth/application-page.png b/docs/content/images/auth/application-page.png
index a51512ba..a51512ba 100644
--- a/docs/images/auth/application-page.png
+++ b/docs/content/images/auth/application-page.png
Binary files differ
diff --git a/docs/images/auth/create-oauth-app.png b/docs/content/images/auth/create-oauth-app.png
index fbee7cda..fbee7cda 100644
--- a/docs/images/auth/create-oauth-app.png
+++ b/docs/content/images/auth/create-oauth-app.png
Binary files differ
diff --git a/docs/images/auth/create-twitter-app.png b/docs/content/images/auth/create-twitter-app.png
index c555464e..c555464e 100644
--- a/docs/images/auth/create-twitter-app.png
+++ b/docs/content/images/auth/create-twitter-app.png
Binary files differ
diff --git a/docs/images/auth/gitlab-application-details.png b/docs/content/images/auth/gitlab-application-details.png
index 6e042886..6e042886 100644
--- a/docs/images/auth/gitlab-application-details.png
+++ b/docs/content/images/auth/gitlab-application-details.png
Binary files differ
diff --git a/docs/images/auth/gitlab-new-application.png b/docs/content/images/auth/gitlab-new-application.png
index be9e4446..be9e4446 100644
--- a/docs/images/auth/gitlab-new-application.png
+++ b/docs/content/images/auth/gitlab-new-application.png
Binary files differ
diff --git a/docs/images/auth/gitlab-sign-in.png b/docs/content/images/auth/gitlab-sign-in.png
index 27aaf6dd..27aaf6dd 100644
--- a/docs/images/auth/gitlab-sign-in.png
+++ b/docs/content/images/auth/gitlab-sign-in.png
Binary files differ
diff --git a/docs/images/auth/keycloak_add_client.png b/docs/content/images/auth/keycloak_add_client.png
index 79121b15..79121b15 100644
--- a/docs/images/auth/keycloak_add_client.png
+++ b/docs/content/images/auth/keycloak_add_client.png
Binary files differ
diff --git a/docs/images/auth/keycloak_client_overview.png b/docs/content/images/auth/keycloak_client_overview.png
index 1ff9d986..1ff9d986 100644
--- a/docs/images/auth/keycloak_client_overview.png
+++ b/docs/content/images/auth/keycloak_client_overview.png
Binary files differ
diff --git a/docs/images/auth/keycloak_clients_overview.png b/docs/content/images/auth/keycloak_clients_overview.png
index 388b3e00..388b3e00 100644
--- a/docs/images/auth/keycloak_clients_overview.png
+++ b/docs/content/images/auth/keycloak_clients_overview.png
Binary files differ
diff --git a/docs/images/auth/keycloak_force_idformat.png b/docs/content/images/auth/keycloak_force_idformat.png
index 1b1bf302..1b1bf302 100644
--- a/docs/images/auth/keycloak_force_idformat.png
+++ b/docs/content/images/auth/keycloak_force_idformat.png
Binary files differ
diff --git a/docs/images/auth/keycloak_idp_cert.png b/docs/content/images/auth/keycloak_idp_cert.png
index 1b899283..1b899283 100644
--- a/docs/images/auth/keycloak_idp_cert.png
+++ b/docs/content/images/auth/keycloak_idp_cert.png
Binary files differ
diff --git a/docs/images/auth/keycloak_mapper_email.png b/docs/content/images/auth/keycloak_mapper_email.png
index b0ad667a..b0ad667a 100644
--- a/docs/images/auth/keycloak_mapper_email.png
+++ b/docs/content/images/auth/keycloak_mapper_email.png
Binary files differ
diff --git a/docs/images/auth/keycloak_mapper_overview.png b/docs/content/images/auth/keycloak_mapper_overview.png
index 8402a0bc..8402a0bc 100644
--- a/docs/images/auth/keycloak_mapper_overview.png
+++ b/docs/content/images/auth/keycloak_mapper_overview.png
Binary files differ
diff --git a/docs/images/auth/keycloak_mapper_username.png b/docs/content/images/auth/keycloak_mapper_username.png
index ccaa8954..ccaa8954 100644
--- a/docs/images/auth/keycloak_mapper_username.png
+++ b/docs/content/images/auth/keycloak_mapper_username.png
Binary files differ
diff --git a/docs/images/auth/keycloak_saml_export_cert.png b/docs/content/images/auth/keycloak_saml_export_cert.png
index e9fa5722..e9fa5722 100644
--- a/docs/images/auth/keycloak_saml_export_cert.png
+++ b/docs/content/images/auth/keycloak_saml_export_cert.png
Binary files differ
diff --git a/docs/images/auth/keycloak_saml_export_cert_details.png b/docs/content/images/auth/keycloak_saml_export_cert_details.png
index 7f4c9e0c..7f4c9e0c 100644
--- a/docs/images/auth/keycloak_saml_export_cert_details.png
+++ b/docs/content/images/auth/keycloak_saml_export_cert_details.png
Binary files differ
diff --git a/docs/images/auth/keycloak_saml_import_cert.png b/docs/content/images/auth/keycloak_saml_import_cert.png
index 9295edab..9295edab 100644
--- a/docs/images/auth/keycloak_saml_import_cert.png
+++ b/docs/content/images/auth/keycloak_saml_import_cert.png
Binary files differ
diff --git a/docs/images/auth/keycloak_saml_import_cert_details.png b/docs/content/images/auth/keycloak_saml_import_cert_details.png
index bb9d1d6c..bb9d1d6c 100644
--- a/docs/images/auth/keycloak_saml_import_cert_details.png
+++ b/docs/content/images/auth/keycloak_saml_import_cert_details.png
Binary files differ
diff --git a/docs/images/auth/mattermost-enable-oauth2.png b/docs/content/images/auth/mattermost-enable-oauth2.png
index af5cdbe2..af5cdbe2 100644
--- a/docs/images/auth/mattermost-enable-oauth2.png
+++ b/docs/content/images/auth/mattermost-enable-oauth2.png
Binary files differ
diff --git a/docs/images/auth/mattermost-oauth-app-add.png b/docs/content/images/auth/mattermost-oauth-app-add.png
index 4a8cdfa7..4a8cdfa7 100644
--- a/docs/images/auth/mattermost-oauth-app-add.png
+++ b/docs/content/images/auth/mattermost-oauth-app-add.png
Binary files differ
diff --git a/docs/images/auth/mattermost-oauth-app-done.png b/docs/content/images/auth/mattermost-oauth-app-done.png
index fcf1beaf..fcf1beaf 100644
--- a/docs/images/auth/mattermost-oauth-app-done.png
+++ b/docs/content/images/auth/mattermost-oauth-app-done.png
Binary files differ
diff --git a/docs/images/auth/mattermost-oauth-app-form.png b/docs/content/images/auth/mattermost-oauth-app-form.png
index 215947bf..215947bf 100644
--- a/docs/images/auth/mattermost-oauth-app-form.png
+++ b/docs/content/images/auth/mattermost-oauth-app-form.png
Binary files differ
diff --git a/docs/images/auth/nextcloud-oauth2-1-settings.png b/docs/content/images/auth/nextcloud-oauth2-1-settings.png
index 82652a54..82652a54 100644
--- a/docs/images/auth/nextcloud-oauth2-1-settings.png
+++ b/docs/content/images/auth/nextcloud-oauth2-1-settings.png
Binary files differ
diff --git a/docs/images/auth/nextcloud-oauth2-2-client-add.png b/docs/content/images/auth/nextcloud-oauth2-2-client-add.png
index 7909fa62..7909fa62 100644
--- a/docs/images/auth/nextcloud-oauth2-2-client-add.png
+++ b/docs/content/images/auth/nextcloud-oauth2-2-client-add.png
Binary files differ
diff --git a/docs/images/auth/nextcloud-oauth2-3-clientid-secret.png b/docs/content/images/auth/nextcloud-oauth2-3-clientid-secret.png
index b05513d1..b05513d1 100644
--- a/docs/images/auth/nextcloud-oauth2-3-clientid-secret.png
+++ b/docs/content/images/auth/nextcloud-oauth2-3-clientid-secret.png
Binary files differ
diff --git a/docs/images/auth/onelogin-add-app.png b/docs/content/images/auth/onelogin-add-app.png
index 356bb852..356bb852 100644
--- a/docs/images/auth/onelogin-add-app.png
+++ b/docs/content/images/auth/onelogin-add-app.png
Binary files differ
diff --git a/docs/images/auth/onelogin-copy-idp-metadata.png b/docs/content/images/auth/onelogin-copy-idp-metadata.png
index 7185f537..7185f537 100644
--- a/docs/images/auth/onelogin-copy-idp-metadata.png
+++ b/docs/content/images/auth/onelogin-copy-idp-metadata.png
Binary files differ
diff --git a/docs/images/auth/onelogin-edit-app-name.png b/docs/content/images/auth/onelogin-edit-app-name.png
index 634d1916..634d1916 100644
--- a/docs/images/auth/onelogin-edit-app-name.png
+++ b/docs/content/images/auth/onelogin-edit-app-name.png
Binary files differ
diff --git a/docs/images/auth/onelogin-edit-sp-metadata.png b/docs/content/images/auth/onelogin-edit-sp-metadata.png
index 111580b1..111580b1 100644
--- a/docs/images/auth/onelogin-edit-sp-metadata.png
+++ b/docs/content/images/auth/onelogin-edit-sp-metadata.png
Binary files differ
diff --git a/docs/images/auth/onelogin-select-template.png b/docs/content/images/auth/onelogin-select-template.png
index 13401816..13401816 100644
--- a/docs/images/auth/onelogin-select-template.png
+++ b/docs/content/images/auth/onelogin-select-template.png
Binary files differ
diff --git a/docs/images/auth/onelogin-use-dashboard.png b/docs/content/images/auth/onelogin-use-dashboard.png
index ea9038ff..ea9038ff 100644
--- a/docs/images/auth/onelogin-use-dashboard.png
+++ b/docs/content/images/auth/onelogin-use-dashboard.png
Binary files differ
diff --git a/docs/images/auth/register-oauth-application-form.png b/docs/content/images/auth/register-oauth-application-form.png
index 5df9a372..5df9a372 100644
--- a/docs/images/auth/register-oauth-application-form.png
+++ b/docs/content/images/auth/register-oauth-application-form.png
Binary files differ
diff --git a/docs/images/auth/register-twitter-application.png b/docs/content/images/auth/register-twitter-application.png
index 442eb680..442eb680 100644
--- a/docs/images/auth/register-twitter-application.png
+++ b/docs/content/images/auth/register-twitter-application.png
Binary files differ
diff --git a/docs/images/auth/twitter-app-confirmation.png b/docs/content/images/auth/twitter-app-confirmation.png
index e24e9d56..e24e9d56 100644
--- a/docs/images/auth/twitter-app-confirmation.png
+++ b/docs/content/images/auth/twitter-app-confirmation.png
Binary files differ
diff --git a/docs/images/auth/twitter-app-keys.png b/docs/content/images/auth/twitter-app-keys.png
index e13be110..e13be110 100644
--- a/docs/images/auth/twitter-app-keys.png
+++ b/docs/content/images/auth/twitter-app-keys.png
Binary files differ
diff --git a/docs/content/images/favicon.png b/docs/content/images/favicon.png
new file mode 100644
index 00000000..80afec65
--- /dev/null
+++ b/docs/content/images/favicon.png
Binary files differ
diff --git a/docs/content/images/hedgedoc_logo_horizontal.svg b/docs/content/images/hedgedoc_logo_horizontal.svg
new file mode 100644
index 00000000..387e2c03
--- /dev/null
+++ b/docs/content/images/hedgedoc_logo_horizontal.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="786" height="197.266" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path d="M248.07 58v79.68h9.297v-35.058h45.416v35.058h9.296V58h-9.296v36.123h-45.416V58zm187.351 0v33.518c-2.372-2.513-5.223-4.478-8.552-5.895-3.33-1.417-6.941-2.125-10.836-2.125-5.134 0-9.73 1.193-13.785 3.584-4.054 2.392-7.243 5.667-9.56 9.828-2.321 4.163-3.48 8.897-3.48 14.208 0 5.314 1.159 10.051 3.48 14.21 2.317 4.161 5.506 7.437 9.56 9.828 4.055 2.391 8.65 3.587 13.785 3.587 4.001 0 7.702-.753 11.102-2.258 3.4-1.506 6.285-3.568 8.659-6.19l.479 7.385h7.913V58zm157.87.106v79.68h21.673c15.653 0 27.676-3.488 36.068-10.466 8.392-6.974 12.59-16.803 12.59-29.48 0-12.642-4.198-22.425-12.59-29.348-8.392-6.923-20.415-10.386-36.068-10.386zm9.296 8.5h12.377c12.606 0 22.275 2.719 29.004 8.153 6.728 5.438 10.091 13.13 10.091 23.082 0 9.985-3.363 17.724-10.09 23.212-6.73 5.49-16.399 8.234-29.005 8.234h-12.377zm-118.295 16.89c-5.134 0-9.73 1.196-13.784 3.587-4.055 2.391-7.244 5.666-9.562 9.827-2.32 4.161-3.48 8.897-3.48 14.21 0 5.312 1.16 10.048 3.48 14.21 2.318 4.16 5.507 7.435 9.562 9.826 4.054 2.391 8.65 3.586 13.784 3.586 3.895 0 7.507-.709 10.837-2.125 3.328-1.416 6.179-3.38 8.551-5.895v2.76c0 7.225-1.815 13.005-5.444 17.345-3.632 4.336-9.216 6.505-16.759 6.505-2.975 0-5.737-.487-8.286-1.46-2.55-.975-4.818-2.329-6.8-4.063l-4.355 7.33c2.619 1.948 5.558 3.46 8.816 4.541 3.258 1.082 6.745 1.62 10.465 1.62 6.763 0 12.457-1.373 17.08-4.116 4.62-2.745 8.116-6.578 10.49-11.5 2.372-4.923 3.558-10.66 3.558-17.211V84.559h-7.915l-.479 7.385c-2.372-2.621-5.258-4.684-8.658-6.19-3.399-1.505-7.1-2.257-11.1-2.257zm281.895 0c-5.312 0-10.049 1.196-14.21 3.587-4.16 2.39-7.436 5.666-9.828 9.828-2.389 4.161-3.584 8.896-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.828 9.826 4.161 2.391 8.898 3.587 14.21 3.587 4.001 0 7.683-.69 11.048-2.072 3.364-1.382 6.286-3.311 8.765-5.79l-6.11-6.056c-1.665 1.842-3.665 3.293-6.001 4.355-2.338 1.063-4.905 1.595-7.702 1.595-3.577 0-6.765-.85-9.562-2.551-2.798-1.7-5.003-4.037-6.614-7.01-1.611-2.975-2.416-6.34-2.416-10.094 0-3.788.805-7.162 2.416-10.12 1.61-2.956 3.816-5.284 6.614-6.983 2.797-1.701 5.985-2.55 9.562-2.55 2.797 0 5.364.522 7.702 1.565a17.433 17.433 0 016.001 4.384l6.11-6.11c-2.479-2.442-5.4-4.355-8.765-5.736-3.365-1.382-7.047-2.072-11.048-2.072zm-413.42.002c-5.24 0-9.932 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.372 4.125-3.56 8.808-3.56 14.05 0 5.384 1.267 10.18 3.8 14.395 2.53 4.214 6.027 7.516 10.49 9.907 4.462 2.39 15.298 3.585 15.298 3.585 3.577 0 7.286-.602 11.13-1.807 3.841-1.204 7.692-3.416 11.552-6.64l-5.152-6.586c-2.622 2.479-5.525 4.276-8.71 5.392-3.19 1.114-6.216 1.673-9.086 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.825-11.61h45.045v-3.557c0-5.347-1.152-10.094-3.454-14.236-2.302-4.144-5.47-7.401-9.507-9.775-4.038-2.37-8.676-3.559-13.918-3.559zm200.366 0c-5.241 0-9.933 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.373 4.125-3.56 8.808-3.56 14.05 0 5.384 1.265 10.18 3.799 14.395 2.53 4.214 6.029 7.516 10.49 9.907 4.462 2.39 9.562 3.585 15.299 3.585 3.577 0 7.285-.602 11.128-1.807 3.842-1.204 7.693-3.416 11.554-6.64l-5.154-6.586c-2.62 2.479-5.523 4.276-8.71 5.392-3.187 1.114-6.215 1.673-9.084 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.826-11.61h45.045v-3.557c0-5.347-1.151-10.094-3.453-14.236-2.302-4.144-5.471-7.401-9.508-9.775-4.038-2.37-8.675-3.559-13.917-3.559zm148.248 0c-5.312 0-10.047 1.194-14.208 3.585-4.162 2.391-7.438 5.667-9.829 9.828-2.389 4.16-3.584 8.897-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.83 9.828 4.16 2.39 8.895 3.585 14.207 3.585 5.311 0 10.048-1.194 14.21-3.585 4.16-2.391 7.435-5.666 9.826-9.827 2.391-4.161 3.586-8.898 3.586-14.211 0-5.311-1.195-10.047-3.586-14.208-2.39-4.161-5.666-7.437-9.827-9.828-4.16-2.391-8.898-3.585-14.209-3.585zM485.09 91.464c3.576 0 6.764.85 9.56 2.552 2.799 1.699 5.004 4.029 6.614 6.983 1.612 2.958 2.417 6.332 2.417 10.12 0 3.754-.805 7.118-2.417 10.093-1.61 2.975-3.815 5.311-6.613 7.012-2.797 1.7-5.985 2.549-9.561 2.549-3.577 0-6.765-.85-9.562-2.549-2.798-1.7-5.002-4.037-6.612-7.012-1.613-2.975-2.418-6.339-2.418-10.093 0-3.788.805-7.162 2.418-10.12 1.61-2.954 3.814-5.284 6.612-6.983 2.797-1.701 5.985-2.552 9.562-2.552zm-68.26.001c3.578 0 6.766.85 9.562 2.55 2.798 1.7 5.002 4.029 6.614 6.985 1.61 2.957 2.416 6.331 2.416 10.118 0 3.754-.806 7.118-2.416 10.093-1.612 2.975-3.816 5.313-6.614 7.012-2.796 1.701-5.984 2.55-9.562 2.55-3.577 0-6.764-.849-9.56-2.55-2.798-1.7-5.003-4.037-6.614-7.012-1.611-2.975-2.417-6.339-2.417-10.093 0-3.787.806-7.16 2.417-10.118 1.61-2.956 3.816-5.285 6.614-6.986 2.796-1.699 5.983-2.549 9.56-2.549zm-64.114 0c4.638 0 8.57 1.46 11.792 4.384 3.222 2.922 5.222 6.7 6.002 11.34h-36.015c.78-4.567 2.834-8.33 6.163-11.288 3.328-2.956 7.348-4.435 12.058-4.435zm200.366 0c4.638 0 8.568 1.46 11.79 4.384 3.222 2.922 5.224 6.7 6.003 11.34H534.86c.779-4.567 2.833-8.33 6.162-11.288 3.328-2.956 7.348-4.435 12.059-4.435zm148.3 0c3.576 0 6.766.85 9.562 2.55 2.798 1.701 5.002 4.03 6.614 6.986 1.61 2.956 2.416 6.33 2.416 10.118 0 3.754-.806 7.119-2.416 10.094-1.612 2.974-3.816 5.31-6.614 7.011-2.796 1.7-5.986 2.55-9.562 2.55-3.577 0-6.764-.85-9.56-2.55-2.798-1.7-5.004-4.037-6.614-7.011-1.613-2.975-2.417-6.34-2.417-10.094 0-3.789.804-7.162 2.417-10.118 1.61-2.956 3.816-5.285 6.613-6.986 2.797-1.7 5.984-2.55 9.561-2.55z" fill-rule="nonzero"/><path d="M187.345 108.66l9.992-9.992-9.992-9.992 7.517-11.963-11.964-7.518 4.667-13.337-13.336-4.667 1.581-14.04-14.04-1.583-1.583-14.042-14.04 1.582-4.668-13.337-13.336 4.666-7.52-11.963L108.66 9.99 98.67 0l-9.992 9.992-11.964-7.517-7.517 11.963L55.86 9.771l-4.667 13.337-14.041-1.583-1.582 14.041-14.04 1.582 1.581 14.04-13.338 4.668 4.667 13.337L2.475 76.71l7.518 11.966L0 98.668l9.992 9.993-7.517 11.964 11.964 7.517-4.667 13.337 13.338 4.668-1.582 14.039 14.04 1.583 1.583 14.04 14.041-1.581 4.667 13.335 13.336-4.665 7.518 11.964 11.963-7.518 9.992 9.899 9.992-9.896 11.964 7.517 7.517-11.966 13.338 4.668 4.666-13.337 14.042 1.581 1.581-14.041 14.042-1.582-1.583-14.04 13.338-4.668-4.667-13.338 11.964-7.517z" fill="#b51f08" fill-rule="nonzero"/><path d="M167.114 114.463c0-19.312-15.655-34.967-34.967-34.967-9.592 0-18.282 3.865-24.599 10.121l-.004-.004-8.909 8.91-7.285-7.285c-6.409-7.312-15.81-11.934-26.296-11.934-19.313 0-34.968 15.655-34.968 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.435 56.196-56.233c7.022-6.608 12.25-15.934 12.25-26.57" fill="#fdd49a" fill-rule="nonzero"/><path d="M98.635 98.522l-7.285-7.284c-6.41-7.312-15.81-11.935-26.297-11.935-19.312 0-34.967 15.656-34.967 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.436" fill="url(#_Linear1)" fill-rule="nonzero"/><path d="M98.669 197.266l-.034-98.744" fill="none"/><path d="M108.65 187.336a14.075 14.075 0 00-10.001-4.157 14.075 14.075 0 00-10.002 4.157c.04 5.49 4.502 9.927 10.001 9.927 5.5 0 9.962-4.439 10.003-9.927M86.967 126.87a7.643 7.643 0 11-15.287 0 7.643 7.643 0 1115.287 0" fill="#010007" fill-rule="nonzero"/><path d="M84.345 125.724a2.116 2.116 0 01-2.118 2.117 2.117 2.117 0 110-4.236 2.12 2.12 0 012.118 2.12" fill="#fffffa" fill-rule="nonzero"/><path d="M125.732 126.87a7.644 7.644 0 11-15.288 0 7.644 7.644 0 1115.288 0" fill="#010007" fill-rule="nonzero"/><path d="M123.11 125.724c0 1.172-.95 2.117-2.118 2.117a2.117 2.117 0 110-4.236 2.12 2.12 0 012.118 2.12" fill="#fffffa" fill-rule="nonzero"/><defs id="defs77"><linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="rotate(-64.537 160.23 25.078) scale(61.7694)"><stop offset="0" id="stop72" stop-color="#fdd49a" stop-opacity="1"/><stop offset="1" id="stop74" stop-color="#dca055" stop-opacity="1"/></linearGradient></defs></svg> \ No newline at end of file
diff --git a/docs/content/images/logo.svg b/docs/content/images/logo.svg
new file mode 100644
index 00000000..8e4071ea
--- /dev/null
+++ b/docs/content/images/logo.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1564" height="1564" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path style="line-height:normal;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;font-feature-settings:normal;font-variation-settings:normal;text-indent:0;text-align:start;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000;text-transform:none;text-orientation:mixed;white-space:normal;shape-padding:0;shape-margin:0;inline-size:0;isolation:auto;mix-blend-mode:normal;solid-color:#000;solid-opacity:1" d="M781.965 0l-79.182 79.19-94.818-59.575-59.574 94.81-105.7-36.99-36.982 105.7-111.283-12.54-12.535 111.276-111.278 12.535 12.541 111.278-105.71 36.988 36.984 105.695-94.815 59.574 59.582 94.832L0 781.961l79.19 79.2-59.577 94.823 94.815 59.573-36.985 105.695 105.707 36.99-12.537 111.264 111.278 12.543 12.535 111.275 111.283-12.535 36.982 105.686 105.694-36.97 59.582 94.821 94.9-59.64 79.096 78.36 79.1-78.343 94.908 59.631 59.572-94.824 105.707 36.988 36.98-105.697 111.284 12.533 12.533-111.283 111.285-12.533-12.543-111.276 105.705-36.99-36.988-105.705 94.814-59.574-59.574-94.813 79.19-79.2-79.188-79.18 59.572-94.813-94.814-59.578 36.99-105.703-105.7-36.983 12.534-111.281-111.275-12.535-12.543-111.283-111.274 12.535-36.99-105.703-105.69 36.986-59.591-94.815-94.82 59.579zm0 77.785l71.305 71.307 85.394-53.656 53.666 85.384 95.172-33.302 33.31 95.185 100.206-11.289 11.296 100.217 100.205 11.289-11.287 100.213 95.182 33.3-33.309 95.188 85.385 53.654-53.648 85.381 71.312 71.309-71.31 71.318 11.666 18.569 41.978 66.812-85.383 53.647 33.311 95.193-95.195 33.31 11.297 100.205-100.215 11.288-11.287 100.216-100.215-11.287-33.301 95.182-95.193-33.31-53.649 85.394-85.289-53.588-18.094 17.922a106.956 106.956 0 0121.871 16.893c-.309 41.33-33.914 74.76-75.33 74.76-41.417 0-75.016-33.42-75.324-74.76a106.994 106.994 0 0122.069-17.01l-17.997-17.828-85.293 53.601-53.65-85.38-95.18 33.29-33.302-95.175-100.217 11.287-11.287-100.205-100.21-11.297 11.29-100.197-95.194-33.311 33.307-95.184-85.385-53.646 53.649-85.39-71.31-71.32 71.32-71.312-53.659-85.4 85.385-53.65-33.305-95.18 95.198-33.313-11.293-100.205 100.207-11.289 11.289-100.207 100.215 11.293 33.302-95.183 95.184 33.308 53.648-85.38 85.391 53.65z" color="#000" font-weight="400" font-family="sans-serif" clip-rule="nonzero" overflow="visible" fill="#fff" fill-rule="nonzero"/><path d="M528.81 636.127c-145.441 0-263.341 117.905-263.341 263.342 0 76 32.23 144.43 83.72 192.49l357.635 357.443c19.257-19.156 45.746-30.984 74.996-30.984 29.295 0 55.839 11.871 75.1 31.09l348.266-348.49c52.88-49.77 92.25-120 92.25-200.1 0-145.437-117.9-263.34-263.34-263.34-72.24 0-137.68 29.112-185.252 76.225l-.033-.035-67.096 67.101-54.863-54.863c-48.267-55.067-119.07-89.88-198.041-89.88zm107.461 300.662c31.804 0 57.57 25.77 57.57 57.57s-25.766 57.569-57.57 57.569c-31.787 0-57.558-25.769-57.558-57.569 0-31.8 25.771-57.57 57.558-57.57zm291.944 0c31.8 0 57.57 25.77 57.57 57.57s-25.77 57.569-57.57 57.569c-31.79 0-57.567-25.769-57.567-57.569 0-31.8 25.777-57.57 57.567-57.57zm-146.27 587.695l.024.023.023-.023h-.047z" fill="#fff" fill-rule="nonzero"/><path d="M674.097 985.728c0 8.82-7.146 15.94-15.95 15.94-8.808 0-15.958-7.12-15.958-15.94 0-8.81 7.15-15.96 15.958-15.96 8.804 0 15.95 7.15 15.95 15.96m291.938 0c0 8.82-7.15 15.94-15.95 15.94-8.81 0-15.96-7.12-15.96-15.94 0-8.81 7.15-15.96 15.96-15.96 8.8 0 15.95 7.15 15.95 15.96" fill="#fffffa" fill-rule="nonzero"/></svg> \ No newline at end of file
diff --git a/docs/images/minio-image-upload/create-bucket.png b/docs/content/images/minio-image-upload/create-bucket.png
index ccfb6715..ccfb6715 100644
--- a/docs/images/minio-image-upload/create-bucket.png
+++ b/docs/content/images/minio-image-upload/create-bucket.png
Binary files differ
diff --git a/docs/images/minio-image-upload/create-policy.png b/docs/content/images/minio-image-upload/create-policy.png
index f9cbd3bf..f9cbd3bf 100644
--- a/docs/images/minio-image-upload/create-policy.png
+++ b/docs/content/images/minio-image-upload/create-policy.png
Binary files differ
diff --git a/docs/images/minio-image-upload/default-view.png b/docs/content/images/minio-image-upload/default-view.png
index fadb50a4..fadb50a4 100644
--- a/docs/images/minio-image-upload/default-view.png
+++ b/docs/content/images/minio-image-upload/default-view.png
Binary files differ
diff --git a/docs/images/minio-image-upload/docker-logs.png b/docs/content/images/minio-image-upload/docker-logs.png
index a25f349a..a25f349a 100644
--- a/docs/images/minio-image-upload/docker-logs.png
+++ b/docs/content/images/minio-image-upload/docker-logs.png
Binary files differ
diff --git a/docs/images/minio-image-upload/open-edit-policy.png b/docs/content/images/minio-image-upload/open-edit-policy.png
index 1dac7bea..1dac7bea 100644
--- a/docs/images/minio-image-upload/open-edit-policy.png
+++ b/docs/content/images/minio-image-upload/open-edit-policy.png
Binary files differ
diff --git a/docs/images/s3-image-upload/bucket-policy-editor.png b/docs/content/images/s3-image-upload/bucket-policy-editor.png
index d5f4427f..d5f4427f 100644
--- a/docs/images/s3-image-upload/bucket-policy-editor.png
+++ b/docs/content/images/s3-image-upload/bucket-policy-editor.png
Binary files differ
diff --git a/docs/images/s3-image-upload/bucket-property.png b/docs/content/images/s3-image-upload/bucket-property.png
index 9f4dc828..9f4dc828 100644
--- a/docs/images/s3-image-upload/bucket-property.png
+++ b/docs/content/images/s3-image-upload/bucket-property.png
Binary files differ
diff --git a/docs/images/s3-image-upload/create-bucket.png b/docs/content/images/s3-image-upload/create-bucket.png
index 925f0926..925f0926 100644
--- a/docs/images/s3-image-upload/create-bucket.png
+++ b/docs/content/images/s3-image-upload/create-bucket.png
Binary files differ
diff --git a/docs/images/s3-image-upload/custom-policy.png b/docs/content/images/s3-image-upload/custom-policy.png
index 01c570cd..01c570cd 100644
--- a/docs/images/s3-image-upload/custom-policy.png
+++ b/docs/content/images/s3-image-upload/custom-policy.png
Binary files differ
diff --git a/docs/images/s3-image-upload/iam-user.png b/docs/content/images/s3-image-upload/iam-user.png
index b26be122..b26be122 100644
--- a/docs/images/s3-image-upload/iam-user.png
+++ b/docs/content/images/s3-image-upload/iam-user.png
Binary files differ
diff --git a/docs/images/s3-image-upload/review-policy.png b/docs/content/images/s3-image-upload/review-policy.png
index 7173788a..7173788a 100644
--- a/docs/images/s3-image-upload/review-policy.png
+++ b/docs/content/images/s3-image-upload/review-policy.png
Binary files differ
diff --git a/docs/index.md b/docs/content/index.md
index fb6f2cb8..df961b02 100644
--- a/docs/index.md
+++ b/docs/content/index.md
@@ -1,6 +1,6 @@
# Welcome to the HedgeDoc Documentation
-![HedgeDoc Logo](images/hedgedoc_logo_horizontal.png)
+![HedgeDoc Logo](images/hedgedoc_logo_horizontal.svg)
HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [HedgeDoc demo server][hedgedoc-demo].
@@ -16,4 +16,4 @@ If you have any questions that aren't answered here, feel free to ask us on [Mat
[hedgedoc-history]: https://hedgedoc.org/history
[hedgedoc-faq]: https://hedgedoc.org/faq
[matrix.org-url]: https://chat.hedgedoc.org
-[hedgedoc-community]: https://community.hedgedoc.org \ No newline at end of file
+[hedgedoc-community]: https://community.hedgedoc.org
diff --git a/docs/legal/developer-certificate-of-origin.txt b/docs/content/legal/developer-certificate-of-origin.txt
index a6bbb984..a6bbb984 100644
--- a/docs/legal/developer-certificate-of-origin.txt
+++ b/docs/content/legal/developer-certificate-of-origin.txt
diff --git a/docs/setup/cloudron.md b/docs/content/setup/cloudron.md
index 3085e6bd..3085e6bd 100644
--- a/docs/setup/cloudron.md
+++ b/docs/content/setup/cloudron.md
diff --git a/docs/setup/docker-linuxserver.md b/docs/content/setup/docker-linuxserver.md
index 1f2597f6..33302f55 100644
--- a/docs/setup/docker-linuxserver.md
+++ b/docs/content/setup/docker-linuxserver.md
@@ -12,7 +12,7 @@
[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf.
-- It supports all the environment variables detailed in the [configuration documentation](../configuration-env-vars.md) to modify it according to your needs.
+- It supports all the environment variables detailed in the [configuration documentation](../configuration.md) to modify it according to your needs.
- It gets rebuilt on new releases from HedgeDoc and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your HedgeDoc instance up to date.
- It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-hedgedoc/#application-setup) HedgeDoc using their [SWAG docker image](https://github.com/linuxserver/docker-swag)
diff --git a/docs/setup/docker.md b/docs/content/setup/docker.md
index f6aeb833..f6aeb833 100644
--- a/docs/setup/docker.md
+++ b/docs/content/setup/docker.md
diff --git a/docs/setup/heroku.md b/docs/content/setup/heroku.md
index e6280051..e6280051 100644
--- a/docs/setup/heroku.md
+++ b/docs/content/setup/heroku.md
diff --git a/docs/setup/kubernetes.md b/docs/content/setup/kubernetes.md
index 7ece0d20..7ece0d20 100644
--- a/docs/setup/kubernetes.md
+++ b/docs/content/setup/kubernetes.md
diff --git a/docs/setup/manual-setup.md b/docs/content/setup/manual-setup.md
index 6cb7c75a..6cb7c75a 100644
--- a/docs/setup/manual-setup.md
+++ b/docs/content/setup/manual-setup.md
diff --git a/docs/setup/reverse-proxy.md b/docs/content/setup/reverse-proxy.md
index b1e7f32f..b1e7f32f 100644
--- a/docs/setup/reverse-proxy.md
+++ b/docs/content/setup/reverse-proxy.md
diff --git a/docs/setup/yunohost.md b/docs/content/setup/yunohost.md
index dac4c0b1..dac4c0b1 100644
--- a/docs/setup/yunohost.md
+++ b/docs/content/setup/yunohost.md
diff --git a/docs/slide-options.md b/docs/content/slide-options.md
index 3cf0f682..3cf0f682 100644
--- a/docs/slide-options.md
+++ b/docs/content/slide-options.md
diff --git a/docs/content/theme/styles/hedgedoc-color.css b/docs/content/theme/styles/hedgedoc-color.css
new file mode 100644
index 00000000..084a2bac
--- /dev/null
+++ b/docs/content/theme/styles/hedgedoc-color.css
@@ -0,0 +1,14 @@
+[data-md-color-primary=hedgedoc] {
+ --md-primary-fg-color: #b51f08;
+ --md-primary-fg-color--light: #b51f08;
+ --md-primary-fg-color--dark: #b51f08;
+ --md-primary-bg-color: hsla(0, 0%, 100%, 1);
+ --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
+}
+
+[data-md-color-accent=hedgedoc] {
+ --md-accent-fg-color: #b51f08;
+ --md-accent-fg-color--transparent: hsla(348, 100%, 55%, 0.1);
+ --md-accent-bg-color: hsla(0, 0%, 100%, 1);
+ --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
+}
diff --git a/docs/url-scheme.md b/docs/content/url-scheme.md
index 35c12fde..35c12fde 100644
--- a/docs/url-scheme.md
+++ b/docs/content/url-scheme.md
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
deleted file mode 100644
index aa3c5253..00000000
--- a/docs/dev/documentation.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Documentation
-
-Our documentation is build with [mkdocs](https://www.mkdocs.org).
-
-## Writing
-
-All documentation files are found in the `docs` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them.
-
-The config file for mkdocs lies in the root of the repo in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured.
-**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website.
-
-## Building
-
-To build the documentation locally you need to perform the following steps:
-
-1. make sure you have python3 installed
-2. install all the dependencies possibly with a [venv](https://docs.python.org/3/library/venv.html):
-`pip install -r mkdocs.requirements.txt`
-3. start the mkdocs dev server `mkdocs serve` or let it build the documentation `mkdocs build`
-
-## Deployment
-
-The documentation is deployed with [Messor Structor](https://github.com/traefik/structor).
-
-The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io.
-
-Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*` and build each one seperatly via `mkdocs` by first installing `mkdocs.requirements.txt` and then building. Afterwards the menu go template is used to include a version switcher in the theme and make all the different versions available. \ No newline at end of file
diff --git a/docs/images/HedgeDoc-1.7.0-features.png b/docs/images/HedgeDoc-1.7.0-features.png
deleted file mode 120000
index c29ae1df..00000000
--- a/docs/images/HedgeDoc-1.7.0-features.png
+++ /dev/null
@@ -1 +0,0 @@
-../../public/screenshot.png \ No newline at end of file
diff --git a/docs/images/favicon.png b/docs/images/favicon.png
deleted file mode 120000
index 2b0c8015..00000000
--- a/docs/images/favicon.png
+++ /dev/null
@@ -1 +0,0 @@
-../../public/icons/favicon-32x32.png \ No newline at end of file
diff --git a/docs/images/hedgedoc_logo_horizontal.png b/docs/images/hedgedoc_logo_horizontal.png
deleted file mode 100644
index 01271424..00000000
--- a/docs/images/hedgedoc_logo_horizontal.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/logo.png b/docs/images/logo.png
deleted file mode 120000
index 22e855a9..00000000
--- a/docs/images/logo.png
+++ /dev/null
@@ -1 +0,0 @@
-../../public/icons/android-chrome-512x512.png \ No newline at end of file
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
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..57d08e48
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs==1.1.2
+mkdocs-material==6.2.3
+pymdown-extensions==8.1