diff options
| author | HesterG <hestergong@gmail.com> | 2023-05-29 21:27:16 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-29 13:27:16 +0000 |
| commit | 0018b0a15ecc886296e28430ccd2fef5756a50b1 (patch) | |
| tree | 6b8808d1e6cc2b7658bd379d2b8d52771fda32d7 /docs/content/doc/development | |
| parent | 79a4c80f8d81e67371f6ff1f8d55bd003ab01208 (diff) | |
| download | gitea-0018b0a15ecc886296e28430ccd2fef5756a50b1.tar.gz gitea-0018b0a15ecc886296e28430ccd2fef5756a50b1.zip | |
Unify doc links to use paths relative to doc folder (#24979)
Changes:
1. Use uniform links types relative to doc folder (start with `doc/`)
2. According to [docusaurus
links](https://docusaurus.io/docs/markdown-features/links), if `<a>` is
used, the `href` is resolved as URL location, but not file location. So
need to use `[text]({{< relref "path" >}})` instead.
Diffstat (limited to 'docs/content/doc/development')
| -rw-r--r-- | docs/content/doc/development/hacking-on-gitea.en-us.md | 7 | ||||
| -rw-r--r-- | docs/content/doc/development/hacking-on-gitea.zh-cn.md | 6 |
2 files changed, 6 insertions, 7 deletions
diff --git a/docs/content/doc/development/hacking-on-gitea.en-us.md b/docs/content/doc/development/hacking-on-gitea.en-us.md index 8ac7fcc34c..0f999215d9 100644 --- a/docs/content/doc/development/hacking-on-gitea.en-us.md +++ b/docs/content/doc/development/hacking-on-gitea.en-us.md @@ -123,9 +123,8 @@ to the Gitea sources. Otherwise, changes can't be pushed. ## Building Gitea (Basic) Take a look at our -<a href='{{< relref "doc/installation/from-source.en-us.md" >}}'>instructions</a> -for <a href='{{< relref "doc/installation/from-source.en-us.md" >}}'>building -from source</a>. +[instructions]({{< relref "doc/installation/from-source.en-us.md" >}}) +for [building from source]({{< relref "doc/installation/from-source.en-us.md" >}}). The simplest recommended way to build from source is: @@ -266,7 +265,7 @@ OpenAPI 3 documentation. When creating new configuration options, it is not enough to add them to the `modules/setting` files. You should add information to `custom/conf/app.ini` and to the -<a href='{{< relref "doc/administration/config-cheat-sheet.en-us.md" >}}'>configuration cheat sheet</a> +[configuration cheat sheet]({{< relref "doc/administration/config-cheat-sheet.en-us.md" >}}) found in `docs/content/doc/administer/config-cheat-sheet.en-us.md` ### Changing the logo diff --git a/docs/content/doc/development/hacking-on-gitea.zh-cn.md b/docs/content/doc/development/hacking-on-gitea.zh-cn.md index 66a95cdd69..6f0ce6bc0b 100644 --- a/docs/content/doc/development/hacking-on-gitea.zh-cn.md +++ b/docs/content/doc/development/hacking-on-gitea.zh-cn.md @@ -115,8 +115,8 @@ git fetch --all --prune ## 构建 Gitea（基本） 看看我们的 -<a href='{{ < relref "doc/installation/from-source.en-us.md" > }}'>说明</a> -关于如何 <a href='{{ < relref "doc/installation/from-source.en-us.md" > }}'>从源代码构建</a> 。 +[说明]({{< relref "doc/installation/from-source.zh-cn.md" >}}) +关于如何[从源代码构建]({{< relref "doc/installation/from-source.zh-cn.md" >}}) 。 从源代码构建的最简单推荐方法是： @@ -249,7 +249,7 @@ make swagger-check ### 创建新的配置选项 创建新的配置选项时，将它们添加到 `modules/setting` 的对应文件。您应该将信息添加到 `custom/conf/app.ini` -并到 <a href = '{{ < relref "doc/administration/config-cheat-sheet.zh-cn.md" > }}'>配置备忘单</a> +并到[配置备忘单]({{< relref "doc/administration/config-cheat-sheet.zh-cn.md" >}}) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 ### 更改Logo |