docs: add images for customization docs

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2023-05-10 17:27:53 +02:00
parent 40e9478c67
commit 0932481117
9 changed files with 29 additions and 1 deletions

View file

@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB