docs: add images for customization docs
Signed-off-by: Philip Molares <philip.molares@udo.edu>
|
@ -88,6 +88,8 @@ more secure authentication like 2FA or WebAuthn.
|
||||||
|
|
||||||
## Customization
|
## 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 |
|
| 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. |
|
| `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_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. |
|
| `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 for the privacy policy, terms of use and imprint on the front page*
|
||||||
|
|
||||||
|
#### Logo
|
||||||
|
|
||||||
|
For this demo we use this image:
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
*logo used on the front page*
|
||||||
|
|
||||||
|

|
||||||
|
*logo used in the editor*
|
||||||
|
|
||||||
|
#### Name
|
||||||
|
|
||||||
|
For this demo we use the name `DEMO Corp`
|
||||||
|
|
||||||
|

|
||||||
|
*name used on the front page*
|
||||||
|
|
||||||
|

|
||||||
|
*name used in the editor*
|
||||||
|
|
||||||
## Database
|
## Database
|
||||||
|
|
||||||
|
|
BIN
docs/content/images/customization/demo_logo.png
Normal file
After Width: | Height: | Size: 21 KiB |
BIN
docs/content/images/customization/links.png
Normal file
After Width: | Height: | Size: 18 KiB |
BIN
docs/content/images/customization/logo/editor_dark.png
Normal file
After Width: | Height: | Size: 14 KiB |
BIN
docs/content/images/customization/logo/editor_light.png
Normal file
After Width: | Height: | Size: 14 KiB |
BIN
docs/content/images/customization/logo/frontpage.png
Normal file
After Width: | Height: | Size: 44 KiB |
BIN
docs/content/images/customization/name/editor_dark.png
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
docs/content/images/customization/name/editor_light.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
docs/content/images/customization/name/frontpage.png
Normal file
After Width: | Height: | Size: 43 KiB |