diff --git a/docs/content/dev/setup/frontend.md b/docs/content/dev/setup/frontend.md index 6ed9cbb6a..618307347 100644 --- a/docs/content/dev/setup/frontend.md +++ b/docs/content/dev/setup/frontend.md @@ -9,12 +9,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 The following environment variables are recognized by the frontend process. -| Name | Possible Values | Description | -|--------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| HD_BASE_URL | Any URL with protocol, domain and optionally directory and port. Must end with a trailing slash. (e.g. `http://localhost:3001/`) | The URL under which the frontend is expected. Setting this is mandatory so the server side rendering can generate assets URLs. You only need to set this yourself if you use the production mode. | -| HD_RENDERER_BASE_URL | Same as `HD_BASE_URL` | You can provide this variable if the renderer should use another domain than the editor. This is recommended for security reasons but not mandatory. This variable is optional and will fallback to `HD_BASE_URL` | -| NEXT_PUBLIC_USE_MOCK_API | `true`, `false` | Will activate the mocked backend | -| NEXT_PUBLIC_TEST_MODE | `true`, `false` | Will activate additional HTML attributes that are used to identify elements for test suits. | +| Name | Possible Values | Description | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HD_BASE_URL | Any URL with protocol, domain and optionally directory and port. Must end with a trailing slash. (e.g. `http://localhost:3001/`) | The URL under which the frontend is expected. Setting this is mandatory so the server side rendering can generate assets URLs. You only need to set this yourself if you use the production mode. | +| HD_RENDERER_BASE_URL | Same as `HD_BASE_URL` | You can provide this variable if the renderer should use another domain than the editor. This is recommended for security reasons but not mandatory. This variable is optional and will fallback to `HD_BASE_URL` | +| NEXT_PUBLIC_USE_MOCK_API | `true`, `false` | Will activate the mocked backend | +| NEXT_PUBLIC_TEST_MODE | `true`, `false` | Will activate additional HTML attributes that are used to identify elements for test suits. | Variables that start with `NEXT_PUBLIC_` will be compiled into the build. You can't change them at after compilation. You shouldn't need to set them yourself. Use the designated npm tasks instead. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 755a3703d..772942e6c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -20,13 +20,15 @@ nav: - References: - 'HedgeDoc Flavored Markdown': references/hfm.md - Development: + - Getting Started: dev/getting-started.md + - Frontend: dev/setup/frontend.md - '2.0 Development': dev/2.0.md - Design Documents: - API Authentication: dev/design_docs/api_auth.md + - Configuration: dev/design_docs/config.md - Events: dev/design_docs/events.md - Notes: dev/design_docs/notes.md - 'User Profiles & Authentication': dev/design_docs/user_profiles.md - - Configuration: dev/design_docs/config.md - 'Writing Docs': dev/documentation.md - FAQ: https://hedgedoc.org/faq markdown_extensions: