diff --git a/docs/content/config/index.md b/docs/content/config/index.md index bf07f9b2d..adccdd73b 100644 --- a/docs/content/config/index.md +++ b/docs/content/config/index.md @@ -88,6 +88,8 @@ more secure authentication like 2FA or WebAuthn. ## Customization +HedgeDoc allows you to set a name or logo for your organization. How this looks and where this is used, can be seen below. You can also provide a privacy policy, terms of use or an imprint url for your HedgeDoc instance. + | environment variable | default | example | description | |-----------------------|---------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `HD_CUSTOM_NAME` | - | `DEMO Corp` | The text will be shown in the top right corner in the editor and on the intro page. If you also configure a custom logo, this will be used as the alt text of the logo. | @@ -96,7 +98,33 @@ more secure authentication like 2FA or WebAuthn. | `HD_TERMS_OF_USE_URL` | - | `https://md.example.com/terms` | The URL that should be linked as the terms of user in the footer. | | `HD_IMPRINT_URL` | - | `https://md.example.com/imprint` | The URL that should be linked as the imprint in the footer. | -**ToDo:** Add screenshots to illustrate custom name and custom logo. +### Example + +#### Links + +![links frontpage](../images/customization/links.png) +*links for the privacy policy, terms of use and imprint on the front page* + +#### Logo + +For this demo we use this image: +![demo logo](../images/customization/demo_logo.png) + +![logo front page](../images/customization/logo/frontpage.png) +*logo used on the front page* + +![logo editor light](../images/customization/logo/editor_light.png)![logo editor dark](../images/customization/logo/editor_dark.png) +*logo used in the editor* + +#### Name + +For this demo we use the name `DEMO Corp` + +![name front page](../images/customization/name/frontpage.png) +*name used on the front page* + +![name editor light](../images/customization/name/editor_light.png)![name editor dark](../images/customization/name/editor_dark.png) +*name used in the editor* ## Database diff --git a/docs/content/images/customization/demo_logo.png b/docs/content/images/customization/demo_logo.png new file mode 100644 index 000000000..da489eed3 Binary files /dev/null and b/docs/content/images/customization/demo_logo.png differ diff --git a/docs/content/images/customization/links.png b/docs/content/images/customization/links.png new file mode 100644 index 000000000..c1edcca9e Binary files /dev/null and b/docs/content/images/customization/links.png differ diff --git a/docs/content/images/customization/logo/editor_dark.png b/docs/content/images/customization/logo/editor_dark.png new file mode 100644 index 000000000..56e07c9fe Binary files /dev/null and b/docs/content/images/customization/logo/editor_dark.png differ diff --git a/docs/content/images/customization/logo/editor_light.png b/docs/content/images/customization/logo/editor_light.png new file mode 100644 index 000000000..24b8c5fb2 Binary files /dev/null and b/docs/content/images/customization/logo/editor_light.png differ diff --git a/docs/content/images/customization/logo/frontpage.png b/docs/content/images/customization/logo/frontpage.png new file mode 100644 index 000000000..4d44a2334 Binary files /dev/null and b/docs/content/images/customization/logo/frontpage.png differ diff --git a/docs/content/images/customization/name/editor_dark.png b/docs/content/images/customization/name/editor_dark.png new file mode 100644 index 000000000..586234262 Binary files /dev/null and b/docs/content/images/customization/name/editor_dark.png differ diff --git a/docs/content/images/customization/name/editor_light.png b/docs/content/images/customization/name/editor_light.png new file mode 100644 index 000000000..c97b64a98 Binary files /dev/null and b/docs/content/images/customization/name/editor_light.png differ diff --git a/docs/content/images/customization/name/frontpage.png b/docs/content/images/customization/name/frontpage.png new file mode 100644 index 000000000..2118e9c7b Binary files /dev/null and b/docs/content/images/customization/name/frontpage.png differ