Fix broken links (#1)

- Always use a relative markdown link so that we can jump even if we edit it in local env or read it in code hosting server. Reviewed-on: https://gitea.com/gitea/docs/pulls/1
2026-09-17 19:55:34 +00:00 · 2024-06-14 05:53:15 +00:00
parent b4dddf8804
commit 9a8396aa29
219 changed files with 487 additions and 644 deletions
@@ -17,7 +17,7 @@ menu:

 Gitea's executable contains all the resources required to run: templates, images, style-sheets
 and translations. Any of them can be overridden by placing a replacement in a matching path
-inside the `custom` directory (see [Customizing Gitea](administration/customizing-gitea.md)).
+inside the `custom` directory (see [Customizing Gitea](../administration/customizing-gitea.md)).

 To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
 can be used from the OS shell interface.
@@ -83,7 +83,7 @@ The default is the current directory.
 The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
 For this to work, the command needs to know the location of the `app.ini` configuration
 file (`--config`) and, depending of the configuration, be ran from the directory where
-Gitea normally starts. See [Customizing Gitea](administration/customizing-gitea.md) for details.
+Gitea normally starts. See [Customizing Gitea](../administration/customizing-gitea.md) for details.

 The `--overwrite` flag allows any existing files in the destination directory to be overwritten.

@@ -772,7 +772,7 @@ and
 - `FORCE_TRUST_SERVER_CERT`: **false**: If set to `true`, completely ignores server certificate validation errors. This option is unsafe. Consider adding the certificate to the system trust store instead.
 - `USER`: **_empty_**: Username of mailing user (usually the sender's e-mail address).
 - `PASSWD`: **_empty_**: Password of mailing user.  Use \`your password\` for quoting if you use special characters in the password.
-  - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup](administration/email-setup.md) for more information.
+  - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or SMTP host is localhost. See [Email Setup](../administration/email-setup.md) for more information.
 - `ENABLE_HELO`: **true**: Enable HELO operation.
 - `HELO_HOSTNAME`: **(retrieved from system)**: HELO hostname.
 - `FROM`: **_empty_**: Mail from address, RFC 5322. This can be just an email address, or the "Name" \<email@example.com\> format.
@@ -82,7 +82,7 @@ directory at the top of this document).
 Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
 which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.

-To obtain any embedded file (including templates), the [`gitea embedded` tool](administration/cmd-embedded.md) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).
+To obtain any embedded file (including templates), the [`gitea embedded` tool](../administration/cmd-embedded.md) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).

 Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
 shouldn't be touched without fully understanding these components.
@@ -54,7 +54,7 @@ Restart Gitea for the configuration changes to take effect.

 To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration.

-For the full list of options check the [Config Cheat Sheet](administration/config-cheat-sheet.md)
+For the full list of options check the [Config Cheat Sheet](../administration/config-cheat-sheet.md)

 Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:

@@ -22,7 +22,7 @@ it is just a matter of:
 - add some configuration to your `app.ini` file
 - restart your Gitea instance

-This supports rendering of whole files. If you want to render code blocks in markdown you would need to do something with javascript. See some examples on the [Customizing Gitea](administration/customizing-gitea.md) page.
+This supports rendering of whole files. If you want to render code blocks in markdown you would need to do something with javascript. See some examples on the [Customizing Gitea](../administration/customizing-gitea.md) page.

 ## Installing external binaries

@@ -20,7 +20,7 @@ menu:
 Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
 You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.

-If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](administration/reverse-proxies.md).
+If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](../administration/reverse-proxies.md).

 To use Gitea's built-in HTTPS support, you must change your `app.ini` file:

@@ -34,7 +34,7 @@ KEY_FILE  = key.pem
 ```

 Note that if your certificate is signed by a third party certificate authority (i.e. not self-signed), then cert.pem should contain the certificate chain. The server certificate must be the first entry in cert.pem, followed by the intermediaries in order (if any). The root certificate does not have to be included because the connecting client must already have it in order to estalbish the trust relationship.
-To learn more about the config values, please checkout the [Config Cheat Sheet](administration/config-cheat-sheet.md#server-server).
+To learn more about the config values, please checkout the [Config Cheat Sheet](../administration/config-cheat-sheet.md#server-server).

 For the `CERT_FILE` or `KEY_FILE` field, the file path is relative to the `GITEA_CUSTOM` environment variable when it is a relative path. It can be an absolute path as well.

@@ -83,11 +83,11 @@ ACME_DIRECTORY=https
 ACME_EMAIL=[email protected]
 ```

-To learn more about the config values, please checkout the [Config Cheat Sheet](administration/config-cheat-sheet.md#server-server).
+To learn more about the config values, please checkout the [Config Cheat Sheet](../administration/config-cheat-sheet.md#server-server).

 ## Using a reverse proxy

-Setup up your reverse proxy as shown in the [reverse proxy guide](administration/reverse-proxies.md).
+Setup up your reverse proxy as shown in the [reverse proxy guide](../administration/reverse-proxies.md).

 After that, enable HTTPS by following one of these guides:

@@ -21,7 +21,7 @@ If you don't want your repository to be visible for search engines read further.
 ## Block search engines indexation using robots.txt

 To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations,
-create a file called `robots.txt` in the [`custom` folder or `CustomPath`](administration/customizing-gitea.md)
+create a file called `robots.txt` in the [`custom` folder or `CustomPath`](../administration/customizing-gitea.md)

 Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).