Use docusaurus warning/note syntax instead markdown

2026-09-19 20:48:52 +00:00 · 2024-06-07 18:03:08 +08:00
parent 91cd95dba0
commit b4dddf8804
139 changed files with 860 additions and 341 deletions
@@ -22,7 +22,9 @@ inside the `custom` directory (see [Customizing Gitea](administration/customizin
 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.

-**NOTE:** The embedded data extraction tool is included in Gitea versions 1.12 and above.
+:::note
+The embedded data extraction tool is included in Gitea versions 1.12 and above.
+:::

 ## Listing resources

@@ -31,7 +31,9 @@ In the default values below, a value in the form `$XYZ` refers to an environment

 Values containing `#` or `;` must be quoted using `` ` `` or `"""`.

-**Note:** A full restart is required for Gitea configuration changes to take effect.
+:::info
+A full restart is required for Gitea configuration changes to take effect.
+:::

 ## Default Configuration (non-`app.ini` configuration)

@@ -96,8 +98,12 @@ In addition there is _`StaticRootPath`_ which can be set as a built-in at build
 - `USE_COMPAT_SSH_URI`: **false**: Force ssh:// clone url instead of scp-style uri when
   default SSH port is used.
 - `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**: Value for Access-Control-Allow-Origin header,
-   default is not to present. **WARNING**: This maybe harmful to you website if you do not
-   give it a right value.
+   default is not to present.
+
+   :::warning
+   This maybe harmful to you website if you do not give it a right value.
+   :::
+
 - `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`:  **false**: Close an issue if a commit on a non default branch marks it as closed.
 - `ENABLE_PUSH_CREATE_USER`:  **false**: Allow users to push local repositories to Gitea and have them automatically created for a user.
 - `ENABLE_PUSH_CREATE_ORG`:  **false**: Allow users to push local repositories to Gitea and have them automatically created for an org.
@@ -441,7 +447,12 @@ The following configuration set `Content-Type: application/vnd.android.package-a
 - `SQLITE_TIMEOUT`: **500**: Query timeout for SQLite3 only.
 - `SQLITE_JOURNAL_MODE`: **""**: Change journal mode for SQlite3. Can be used to enable [WAL mode](https://www.sqlite.org/wal.html) when high load causes write congestion. See [SQlite3 docs](https://www.sqlite.org/pragma.html#pragma_journal_mode) for possible values. Defaults to the default for the database file, often DELETE.
 - `ITERATE_BUFFER_SIZE`: **50**: Internal buffer size for iterating.
- `CHARSET`: **utf8mb4**: For MySQL only, either "utf8" or "utf8mb4". NOTICE: for "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
+- `CHARSET`: **utf8mb4**: For MySQL only, either "utf8" or "utf8mb4".
+
+  :::note
+  For "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
+  :::
+
 - `PATH`: **data/gitea.db**: For SQLite3 only, the database file path.
 - `LOG_SQL`: **true**: Log the executed SQL.
 - `DB_RETRIES`: **10**: How many ORM init / DB connect attempts allowed.
@@ -556,13 +567,17 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
   Number of trusted proxy count. Set to zero to not use these headers.
 - `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: List of IP addresses and networks separated by comma of trusted proxy servers. Use `*` to trust all.
 - `DISABLE_GIT_HOOKS`: **true**: Set to `false` to enable users with Git Hook privilege to create custom Git Hooks.
-   WARNING: Custom Git Hooks can be used to perform arbitrary code execution on the host operating system.
+
+   :warning
+   Custom Git Hooks can be used to perform arbitrary code execution on the host operating system.
   This enables the users to access and modify this config file and the Gitea database and interrupt the Gitea service.
   By modifying the Gitea database, users can gain Gitea administrator privileges.
   It also enables them to access other resources available to the user on the operating system that is running the
   Gitea instance and perform arbitrary actions in the name of the Gitea OS user.
   This maybe harmful to you website or your operating system.
   Setting this to true does not change existing hooks in git repos; adjust it before if necessary.
+   :::
+
 - `DISABLE_WEBHOOKS`: **false**: Set to `true` to disable webhooks feature.
 - `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: Set to `false` to allow local users to push to gitea-repositories without setting up the Gitea environment. This is not recommended and if you want local users to push to Gitea repositories you should set the environment appropriately.
 - `IMPORT_LOCAL_PATHS`: **false**: Set to `false` to prevent all users (including admin) from importing local path on server.
@@ -638,8 +653,12 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
 - `DISABLE_REGISTRATION`: **false**: Disable registration, after which only admin can create
   accounts for users.
 - `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: Enable this to force externally created
-   accounts (via GitHub, OpenID Connect, etc) to create a password. Warning: enabling this will
-   decrease security, so you should only enable it if you know what you're doing.
+   accounts (via GitHub, OpenID Connect, etc) to create a password.
+
+   :::warning
+   Enabling this will decrease security, so you should only enable it if you know what you're doing.
+   :::
+
 - `REQUIRE_SIGNIN_VIEW`: **false**: Enable this to force users to log in to view any page or to use API.
 - `ENABLE_NOTIFY_MAIL`: **false**: Enable this to send e-mail to watchers of a repository when
   something happens, like creating issues. Requires `Mailer` to be enabled.
@@ -1222,7 +1241,9 @@ Task queue configuration has been moved to `queue.task`. However, the below conf
 - `SHARE_USER_STATISTICS`: **true**: Enable/Disable user statistics for nodeinfo if federation is enabled
 - `MAX_SIZE`: **4**: Maximum federation request and response size (MB)

- WARNING: Changing the settings below can break federation.
+  :::warning
+  Changing the settings below can break federation.
+  :::

 - `ALGORITHMS`: **rsa-sha256, rsa-sha512, ed25519**: HTTP signature algorithms
 - `DIGEST_ALGORITHM`: **SHA-256**: HTTP signature digest algorithm
@@ -44,7 +44,9 @@ is set under the "Configuration" tab on the site administration page.

 - [List of Environment Variables](https://docs.gitea.io/en-us/environment-variables/)

-**Note:** Gitea must perform a full restart to see configuration changes.
+:::note
+Gitea must perform a full restart to see configuration changes.
+:::

 ## Serving custom public files

@@ -270,7 +272,9 @@ Google Analytics, Matomo (previously Piwik), and other analytics services can be

 Place custom files in corresponding sub-folder under `custom/options`.

-**NOTE:** The files should not have a file extension, e.g. `Labels` rather than `Labels.txt`
+:::note
+The files should not have a file extension, e.g. `Labels` rather than `Labels.txt`
+:::

 ### gitignores

@@ -306,7 +310,7 @@ Gitea's default locale files can be found in the [`options/locale`](https://gith

 To add a completely new locale, as well as placing the file in the above location, you will need to add the new lang and name to the `[i18n]` section in your `app.ini`. Keep in mind that Gitea will use those settings as **overrides**, so if you want to keep the other languages as well you will need to copy/paste the default values and add your own to them.

-```
+```ini title="app.ini"
 [i18n]
 LANGS = en-US,foo-BAR
 NAMES = English,FooBar
@@ -320,14 +324,16 @@ Locales may change between versions, so keeping track of your customized locales

 To add a custom Readme, add a markdown formatted file (without an `.md` extension) to `$GITEA_CUSTOM/options/readme`

-**NOTE:** readme templates support **variable expansion**.
+:::note
+Readme templates support **variable expansion**.
 currently there are `{Name}` (name of repository), `{Description}`, `{CloneURL.SSH}`, `{CloneURL.HTTPS}` and `{OwnerName}`
+:::

 ### Reactions

 To change reaction emoji's you can set allowed reactions at app.ini

-```
+```ini title="app.ini"
 [ui]
 REACTIONS = +1, -1, laugh, confused, heart, hooray, eyes
 ```
@@ -27,4 +27,6 @@ LFS_START_SERVER = true
 PATH = /home/gitea/data/lfs
 ```

-**Note**: LFS server support needs at least Git v2.1.2 installed on the server
+:::note
+LFS server support needs at least Git v2.1.2 installed on the server
+:::
@@ -95,4 +95,6 @@ After that, enable HTTPS by following one of these guides:
 - [apache2/httpd](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html)
 - [caddy](https://caddyserver.com/docs/tls)

-Note: Enabling HTTPS only at the proxy level is referred as [TLS Termination Proxy](https://en.wikipedia.org/wiki/TLS_termination_proxy). The proxy server accepts incoming TLS connections, decrypts the contents, and passes the now unencrypted contents to Gitea. This is normally fine as long as both the proxy and Gitea instances are either on the same machine, or on different machines within private network (with the proxy is exposed to outside network). If your Gitea instance is separated from your proxy over a public network, or if you want full end-to-end encryption, you can also [enable HTTPS support directly in Gitea using built-in server](#using-the-built-in-server) and forward the connections over HTTPS instead.
+:::note
+Enabling HTTPS only at the proxy level is referred as [TLS Termination Proxy](https://en.wikipedia.org/wiki/TLS_termination_proxy). The proxy server accepts incoming TLS connections, decrypts the contents, and passes the now unencrypted contents to Gitea. This is normally fine as long as both the proxy and Gitea instances are either on the same machine, or on different machines within private network (with the proxy is exposed to outside network). If your Gitea instance is separated from your proxy over a public network, or if you want full end-to-end encryption, you can also [enable HTTPS support directly in Gitea using built-in server](#using-the-built-in-server) and forward the connections over HTTPS instead.
+:::
@@ -171,7 +171,9 @@ In case you already have a site, and you want Gitea to share the domain name, yo

 Then you **MUST** set something like `[server] ROOT_URL = http://git.example.com/git/` correctly in your configuration.

-Note: The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`.
+:::note
+The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`.
+:::

 ## Caddy

@@ -56,7 +56,7 @@ Since Golang doesn't support import cycles, we have to decide the package depend

 From left to right, left packages could depend on right packages, but right packages MUST not depend on left packages. The sub packages on the same level could depend on according this level's rules.

-**NOTICE**
+:::warning

 Why do we need database transactions outside of `models`? And how?
 Some actions should allow for rollback when database record insertion/update/deletion failed.
@@ -89,6 +89,8 @@ func UpdateIssue(ctx context.Context, repoID int64) error {
 }
 ```

+:::
+
 ### Package Name

 For the top level package, use a plural as package name, i.e. `services`, `models`, for sub packages, use singular,
@@ -30,17 +30,21 @@ Next, [install Node.js with npm](https://nodejs.org/en/download/) which is
 required to build the JavaScript and CSS files. The minimum supported Node.js
 version is @minNodeVersion@ and the latest LTS version is recommended.

-**Note**: When executing make tasks that require external tools, like
+:::note
+When executing make tasks that require external tools, like
 `make watch-backend`, Gitea will automatically download and build these as
 necessary. To be able to use these you must have the `"$GOPATH"/bin` directory
 on the executable path. If you don't add the go bin directory to the
 executable path you will have to manage this yourself.
+:::

-**Note 2**: Go version @minGoVersion@ or higher is required.
+:::note
+Go version @minGoVersion@ or higher is required.
 Gitea uses `gofmt` to format source code. However, the results of
 `gofmt` can differ by the version of `go`. Therefore it is
 recommended to install the version of Go that our continuous integration is
 running. As of last update, the Go version should be @goVersion@.
+:::

 ## Installing Make

@@ -77,7 +81,9 @@ One of these three distributions of Make will run on Windows:
  - To compile Gitea with CGO_ENABLED (eg: SQLite3), you might need to use [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) instead of MSYS2 gcc, because MSYS2 gcc headers lack some Windows-only CRT functions like `_beginthread`.
 - [Chocolatey package](https://chocolatey.org/packages/make). Run `choco install make`

-**Note**: If you are attempting to build using make with Windows Command Prompt, you may run into issues. The above prompts (Git bash, or MinGW) are recommended, however if you only have command prompt (or potentially PowerShell) you can set environment variables using the [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) command, e.g. `set TAGS=bindata`.
+:::note
+If you are attempting to build using make with Windows Command Prompt, you may run into issues. The above prompts (Git bash, or MinGW) are recommended, however if you only have command prompt (or potentially PowerShell) you can set environment variables using the [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) command, e.g. `set TAGS=bindata`.
+:::

 ## Downloading and cloning the Gitea source code

@@ -251,8 +257,9 @@ server will check that this has been done using:
 make swagger-check
 ```

-**Note**: Please note you should use the Swagger 2.0 documentation, not the
-OpenAPI 3 documentation.
+:::note
+Please note you should use the Swagger 2.0 documentation, not the OpenAPI 3 documentation.
+:::

 ### Creating new configuration options

@@ -82,7 +82,9 @@ For public clients, a redirect URI of a loopback IP address such as `http://127.

 ## Example

-**Note:** This example does not use PKCE.
+:::note
+This example does not use PKCE.
+:::

 1. Redirect to user to the authorization endpoint in order to get their consent for accessing the resources:

@@ -23,7 +23,9 @@ For more help resources, check all [Support Options](help/seek-help.md).

 Version 1.7.x will be used for this example.

-**NOTE:** this example applies to Docker images as well!
+:::note
+This example applies to Docker images as well!
+:::

 On our [downloads page](https://dl.gitea.io/gitea/) you will see a 1.7 directory, as well as directories for 1.7.0, 1.7.1, 1.7.2, 1.7.3, 1.7.4, 1.7.5, and 1.7.6.

@@ -163,7 +165,9 @@ You can configure `EMAIL_DOMAIN_WHITELIST` or `EMAIL_DOMAIN_BLOCKLIST` in your a

 You can configure `WHITELISTED_URIS` or `BLACKLISTED_URIS` under `[openid]` in your `app.ini`

-**NOTE:** whitelisted takes precedence, so if it is non-blank then blacklisted is ignored
+:::note
+Whitelisted takes precedence, so if it is non-blank then blacklisted is ignored
+:::

 ### Issue only users

@@ -19,7 +19,9 @@ menu:
 - [Discord](https://discord.gg/Gitea)
 - [Discourse Forum](https://discourse.gitea.io/)

-**NOTE:** When asking for support, it may be a good idea to have the following available so that the person helping has all the info they need:
+:::note
+When asking for support, it may be a good idea to have the following available so that the person helping has all the info they need:
+:::

 1. Your `app.ini` (with any sensitive data scrubbed as necessary).
 2. The Gitea logs, and any other appropriate log files for the situation.
@@ -19,7 +19,9 @@ You need a database to use Gitea. Gitea supports PostgreSQL (>=10), MySQL (>=5.7

 Database instance can be on same machine as Gitea (local database setup), or on different machine (remote database).

-Note: All steps below requires that the database engine of your choice is installed on your system. For remote database setup, install the server application on database instance and client program on your Gitea server. The client program is used to test connection to the database from Gitea server, while Gitea itself use database driver provided by Go to accomplish the same thing. In addition, make sure you use same engine version for both server and client for some engine features to work. For security reason, protect `root` (MySQL) or `postgres` (PostgreSQL) database superuser with secure password. The steps assumes that you run Linux for both database and Gitea servers.
+:::note
+All steps below requires that the database engine of your choice is installed on your system. For remote database setup, install the server application on database instance and client program on your Gitea server. The client program is used to test connection to the database from Gitea server, while Gitea itself use database driver provided by Go to accomplish the same thing. In addition, make sure you use same engine version for both server and client for some engine features to work. For security reason, protect `root` (MySQL) or `postgres` (PostgreSQL) database superuser with secure password. The steps assumes that you run Linux for both database and Gitea servers.
+:::

 ## MySQL

@@ -60,8 +60,10 @@ despite warnings like `This key is not certified with a trusted signature!`.

 ## Recommended server configuration

-**NOTE:** Many of the following directories can be configured using [Environment Variables](administration/environment-variables.md) as well!
+:::note
+Many of the following directories can be configured using [Environment Variables](administration/environment-variables.md) as well!
 Of note, configuring `GITEA_WORK_DIR` will tell Gitea where to base its working directory, as well as ease installation.
+:::

 ### Prepare environment

@@ -95,8 +97,10 @@ chown root:git /etc/gitea
 chmod 770 /etc/gitea
 ```

-> **NOTE:** `/etc/gitea` is temporarily set with write permissions for user `git` so that the web installer can write the configuration file. After the installation is finished, it is recommended to set permissions to read-only using:
->
+:::note
+> `/etc/gitea` is temporarily set with write permissions for user `git` so that the web installer can write the configuration file. After the installation is finished, it is recommended to set permissions to read-only using:
+:::
+
 > ```sh
 > chmod 750 /etc/gitea
 > chmod 640 /etc/gitea/app.ini
@@ -113,7 +117,9 @@ See the [command line documentation](administration/command-line.md) for informa

 ### Configure Gitea's working directory

-**NOTE:** If you plan on running Gitea as a Linux service, you can skip this step, as the service file allows you to set `WorkingDirectory`. Otherwise, consider setting this environment variable (semi-)permanently so that Gitea consistently uses the correct working directory.
+:::note
+If you plan on running Gitea as a Linux service, you can skip this step, as the service file allows you to set `WorkingDirectory`. Otherwise, consider setting this environment variable (semi-)permanently so that Gitea consistently uses the correct working directory.
+:::

 ```sh
 export GITEA_WORK_DIR=/var/lib/gitea/
@@ -169,7 +175,9 @@ To restart your Gitea instance, we recommend to use SIGHUP signal. If you know y

 To gracefully stop the Gitea instance, a simple `kill $GITEA_PID` or `killall gitea` is enough.

-**NOTE:** We don't recommend to use the SIGKILL signal (`-9`); you may be forcefully stopping some of Gitea's internal tasks, and it will not gracefully stop (tasks in queues, indexers, etc.)
+:::note
+We don't recommend to use the SIGKILL signal (`-9`); you may be forcefully stopping some of Gitea's internal tasks, and it will not gracefully stop (tasks in queues, indexers, etc.)
+:::

 See below for troubleshooting instructions to repair broken repositories after
 an update of your Gitea version.
@@ -25,15 +25,19 @@ Next, [install Node.js with npm](https://nodejs.org/en/download/) which is
 required to build the JavaScript and CSS files. The minimum supported Node.js
 version is @minNodeVersion@ and the latest LTS version is recommended.

-**Note**: When executing make tasks that require external tools, like
+:::note
+When executing make tasks that require external tools, like
 `make misspell-check`, Gitea will automatically download and build these as
 necessary. To be able to use these, you must have the `"$GOPATH/bin"` directory
 on the executable path. If you don't add the go bin directory to the
 executable path, you will have to manage this yourself.
+:::

-**Note 2**: Go version @minGoVersion@ or higher is required. However, it is recommended to
+:::note
+Go version @minGoVersion@ or higher is required. However, it is recommended to
 obtain the same version as our continuous integration, see the advice given in
 [Hacking on Gitea](development/hacking-on-gitea.md)
+:::

 ## Download

@@ -44,7 +44,7 @@ Gitea comes with a health check endpoint `/api/healthz`, you can configure it in

 a successful health check response will respond with http code `200`, here's example:

-```
+```json
 HTTP/1.1 200 OK

 {
@@ -240,8 +240,10 @@ started properly. Logs can be viewed with `docker-compose logs`.
 To shut down the setup, execute `docker-compose down`. This will stop
 and kill the containers. The volumes will still exist.

-Notice: if using a non-3000 port on http, change app.ini to match
+:::note
+If using a non-3000 port on http, change app.ini to match
 `LOCAL_ROOT_URL = http://localhost:3000/`.
+:::

 ## Install

@@ -250,7 +252,7 @@ favorite browser to finalize the installation. Visit http://server-ip:3000 and f
 installation wizard. If the database was started with the `docker-compose` setup as
 documented above, please note that `db` must be used as the database hostname.

-# Customization
+## Customization

 Customization files described [here](https://docs.gitea.io/en-us/customizing-gitea/) should
 be placed in `/var/lib/gitea/custom` directory. If using host volumes, it's quite easy to access these
@@ -258,13 +260,15 @@ files; for named volumes, this is done through another container or by direct ac
 `/var/lib/docker/volumes/gitea_gitea/_/var_lib_gitea`. The configuration file will be saved at
 `/etc/gitea/app.ini` after the installation.

-# Upgrading
+## Upgrading

+:::warning
 :exclamation::exclamation: **Make sure you have volumed data to somewhere outside Docker container** :exclamation::exclamation:
+:::

 To upgrade your installation to the latest release:

-```
+```bash
 # Edit `docker-compose.yml` to update the version, if you have one specified
 # Pull new images
 docker-compose pull
@@ -272,7 +276,7 @@ docker-compose pull
 docker-compose up -d
 ```

-# Upgrading from standard image
+## Upgrading from standard image

 - Backup your setup
 - Change volume mountpoint from /data to /var/lib/gitea
@@ -241,8 +241,10 @@ started properly. Logs can be viewed with `docker-compose logs`.
 To shut down the setup, execute `docker-compose down`. This will stop
 and kill the containers. The volumes will still exist.

-Notice: if using a non-3000 port on http, change app.ini to match
+:::note
+If using a non-3000 port on http, change app.ini to match
 `LOCAL_ROOT_URL = http://localhost:3000/`.
+:::

 ## Installation

@@ -267,7 +269,9 @@ files; for named volumes, this is done through another container or by direct ac

 ## Upgrading

+:::warning
 :exclamation::exclamation: **Make sure you have volumed data to somewhere outside Docker container** :exclamation::exclamation:
+:::

 To upgrade your installation to the latest release:

@@ -47,7 +47,9 @@ For example, these are all valid image names for the owner `testuser`:

 `gitea.example.com/testuser/my/image`

-**NOTE:** The registry only supports case-insensitive tag names. So `image:tag` and `image:Tag` get treated as the same image and tag.
+:::note
+The registry only supports case-insensitive tag names. So `image:tag` and `image:Tag` get treated as the same image and tag.
+:::

 ## Push an image

@@ -345,4 +345,6 @@ If set `ENABLE_REVERSE_PROXY_FULL_NAME=true`, a user full name expected in `X-WE

 You can also limit the reverse proxy's IP address range with `REVERSE_PROXY_TRUSTED_PROXIES` which default value is `127.0.0.0/8,::1/128`. By `REVERSE_PROXY_LIMIT`, you can limit trusted proxies level.

-Notice: Reverse Proxy Auth doesn't support the API. You still need an access token or basic auth to make API requests.
+:::note
+Reverse Proxy Auth doesn't support the API. You still need an access token or basic auth to make API requests.
+:::
@@ -37,7 +37,9 @@ For an existing remote repository, you can set up pull mirroring as follows:

 The repository now gets mirrored periodically from the remote repository. You can force a sync by selecting **Synchronize Now** in the repository settings.

-:exclamation::exclamation: **NOTE:** You can only set up pull mirroring for repos that don't exist yet on your instance. Once the repo is created, you can't convert it into a pull mirror anymore. :exclamation::exclamation:
+:::warning
+:exclamation::exclamation: You can only set up pull mirroring for repos that don't exist yet on your instance. Once the repo is created, you can't convert it into a pull mirror anymore. :exclamation::exclamation:
+:::

 ## Pushing to a remote repository

@@ -50,7 +52,9 @@ For an existing repository, you can set up push mirroring as follows:

 The repository now gets mirrored periodically to the remote repository. You can force a sync by selecting **Synchronize Now**. In case of an error a message displayed to help you resolve it.

-:exclamation::exclamation: **NOTE:** This will force push to the remote repository. This will overwrite any changes in the remote repository! :exclamation::exclamation:
+:::warning
+:exclamation::exclamation: This will force push to the remote repository. This will overwrite any changes in the remote repository! :exclamation::exclamation:
+:::

 ### Setting up a push mirror from Gitea to GitHub

@@ -39,7 +39,9 @@ a/b/c/d.json
 **.[bB][aA][tT]
 ```

-**NOTE:** The `template` file will be removed from the `.gitea` directory when a repository is generated from the template.
+:::note
+The `template` file will be removed from the `.gitea` directory when a repository is generated from the template.
+:::

 ## Variable Expansion

@@ -32,12 +32,14 @@ All event pushes are POST requests. The methods currently supported are:

 ### Event information

-**WARNING**: The `secret` field in the payload is deprecated as of Gitea 1.13.0 and will be removed in 1.14.0: https://github.com/go-gitea/gitea/issues/11755
+:::warning
+The `secret` field in the payload is deprecated as of Gitea 1.13.0 and will be removed in 1.14.0: https://github.com/go-gitea/gitea/issues/11755
+:::

 The following is an example of event information that will be sent by Gitea to
 a Payload URL:

-```
+```http
 X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
 X-GitHub-Event: push
 X-Gogs-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
@@ -131,7 +133,7 @@ In your repository Settings, under Webhooks, Setup a Gitea webhook as follows:

 Now on your server create the php file webhook.php

-```
+```php
 <?php

 $secret_key = '123';