From d7c1e458148712f4392bfc37b5f1d19b18a4e6ac Mon Sep 17 00:00:00 2001 From: Philip Molares Date: Thu, 11 Jun 2026 16:06:37 +0200 Subject: [PATCH] refactor(docs): fix links Signed-off-by: Philip Molares --- docs/content/faq.md | 8 ++++---- docs/content/guides/media/s3-google-cloud-storage.md | 2 +- docs/content/index.md | 2 +- docs/content/references/yaml-metadata.md | 2 +- docs/content/setup/docker.md | 6 +++--- docs/content/setup/getting-started.md | 4 ++-- docs/content/setup/manual-setup.md | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/content/faq.md b/docs/content/faq.md index 18426394..58d5532e 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -47,17 +47,17 @@ If you still want to allow embedding via iframe, ensure that: - `cookiePolicy` / `CMD_COOKIE_POLICY` is set to `none` (Otherwise you will get a `AUTH failed: No cookie transmitted` error.) - `csp.allowFraming` / `CMD_CSP_ALLOW_FRAMING` is set to `true` -See also the [configuration docs](/configuration/#web-security-aspects) for more information about these options. +See also the [configuration docs](configuration.md#web-security-aspects) for more information about these options. ## I can't upload images or the upload gets stuck This problem is typically accompanied by the error `Invalid URL: /uploads/` in the log and is often caused by a missing `domain` / `CMD_DOMAIN` config option or an incorrect reverse proxy config. -Have a look at our [reverse proxy documentation](https://docs.hedgedoc.org/guides/reverse-proxy/) +Have a look at our [reverse proxy documentation](guides/reverse-proxy.md) and make sure that `protocolUseSSL` / `CMD_PROTOCOL_USESSL` is set to `true` if you serve HedgeDoc via HTTPS. ## HedgeDoc fails executing migrations and does not start Unfortunately, older versions of HedgeDoc had some bugs regarding migrations and didn't always record that a migration was executed. -Have a look at the *[Troubleshooting Migrations](/guides/migration-troubleshooting/)* guide for more information. +Have a look at the *[Troubleshooting Migrations](guides/migration-troubleshooting.md)* guide for more information. ## Why does my interface look weird? @@ -76,4 +76,4 @@ You should check the following settings (or their corresponding environment vari - `protocolUseSSL` (env: `CMD_PROTOCOL_USESSL`) - `urlAddPort` (env: `CMD_URL_ADDPORT`) -Check [the reverse proxy guide](../guides/reverse-proxy/#configure-asset-link-generation) for an explanation. +Check [the reverse proxy guide](guides/reverse-proxy.md#configure-asset-link-generation) for an explanation. diff --git a/docs/content/guides/media/s3-google-cloud-storage.md b/docs/content/guides/media/s3-google-cloud-storage.md index 03e42dc0..8e5122f7 100644 --- a/docs/content/guides/media/s3-google-cloud-storage.md +++ b/docs/content/guides/media/s3-google-cloud-storage.md @@ -63,7 +63,7 @@ In order to view the images uploaded to HedgeDoc the storage bucket needs to be ## Configure HedgeDoc -Set the following environment variables (or the [corresponding config.json values](/configuration/#amazon-s3)): +Set the following environment variables (or the [corresponding config.json values](../../configuration.md#amazon-s3)): ```env CMD_IMAGE_UPLOAD_TYPE="s3" diff --git a/docs/content/index.md b/docs/content/index.md index 9500f24e..2b39b558 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -16,6 +16,6 @@ If you have any questions that aren't answered here, feel free to ask us on [Mat [hedgedoc-demo]: https://demo.hedgedoc.org [hedgedoc-history]: https://hedgedoc.org/history [hedgedoc-history-details]: https://hedgedoc.org/history/details -[hedgedoc-faq]: /faq +[hedgedoc-faq]: faq.md [matrix.org-url]: https://chat.hedgedoc.org [hedgedoc-community]: https://community.hedgedoc.org diff --git a/docs/content/references/yaml-metadata.md b/docs/content/references/yaml-metadata.md index a23c0861..93556615 100644 --- a/docs/content/references/yaml-metadata.md +++ b/docs/content/references/yaml-metadata.md @@ -25,7 +25,7 @@ title: meta title ## description -This option will set the note description as a `` tag. This only affects the [Publish](../features#Share-Notes) function. +This option will set the note description as a `` tag. This only affects the Publish function. > default: not set diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md index 39dd0910..c0b780d6 100644 --- a/docs/content/setup/docker.md +++ b/docs/content/setup/docker.md @@ -13,7 +13,7 @@ The easiest way to get started with HedgeDoc and Docker is to use the following !!! warning This is a minimal example to get started quickly and not intended for production use. - For more information about production use see [this guide](/guides/production-ready). + For more information about production use see [this guide](../guides/production-ready.md). ```yaml version: '3' @@ -47,7 +47,7 @@ volumes: ``` After executing `docker-compose up`, HedgeDoc should be available at [http://localhost:3000](http://localhost:3000). You can now continue to configure your container with environment variables. -Check out [the configuration docs](/configuration) for more details. +Check out [the configuration docs](../configuration.md) for more details. ## File Permissions @@ -83,7 +83,7 @@ Then run `docker-compose up` to start HedgeDoc again. ### Migrating from CodiMD & HackMD If you currently use CodiMD or HackMD, you should be able to swap the docker image for ours. -See [the general migration hints](/setup/getting-started/#migrating-from-codimd-hackmd) for compatibility details. +See [the general migration hints](../setup/getting-started.md#migrating-from-codimd-hackmd) for compatibility details. ## Backup diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md index c8679183..6cc410ab 100644 --- a/docs/content/setup/getting-started.md +++ b/docs/content/setup/getting-started.md @@ -5,8 +5,8 @@ To set up your instance follow these steps: 1. Choose an installation method and follow the instructions 2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/) -3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) -4. If you didn't disable [local accounts](/configuration/#email-local-account), you can use the "Sign In" button to +3. [Configure HedgeDoc](../configuration.md) +4. If you didn't disable [local accounts](../configuration.md#email-local-account), you can use the "Sign In" button to create an account, login and start using HedgeDoc. Follow us on :fontawesome-brands-mastodon:{: .mastodon }Mastodon for updates. diff --git a/docs/content/setup/manual-setup.md b/docs/content/setup/manual-setup.md index e8d3e8fb..88606687 100644 --- a/docs/content/setup/manual-setup.md +++ b/docs/content/setup/manual-setup.md @@ -56,7 +56,7 @@ If you want to upgrade HedgeDoc from an older version, follow these steps: -1. Check if you still meet the [requirements at the top of this document](#requirements-on-your-server). +1. Check if you still meet the [requirements at the top of this document](#manual-installation). 2. Ensure you read the [release notes](https://hedgedoc.org/releases/) of all versions between your current version and the latest release. 2. Fully stop your old HedgeDoc server.