Browse Source

fix links

ruki 6 months ago
parent
commit
a4d64a1607

+ 1 - 1
docs/about/sponsor.md

@@ -64,7 +64,7 @@ Feel free to contact us for more details on sponsorship.
 
 - All previous tier rewards
 - Add a logo and link to the README.md of my major open source projects
-- One-to-one technical consulting service, see [Technical Support](https://xmake.io/#/about/technical_support)
+- One-to-one technical consulting service
 
 ### $500 a month
 

+ 1 - 1
docs/api/description/global-interfaces.md

@@ -413,7 +413,7 @@ please input: y (y/n)
 ```
 
 For a complete introduction to this and the installation and use of all third-party packages,
-you can refer to the document: [Third-party dependency package installation](https://xmake.io/#/package/remote_package?id=install-third-party-packages)
+you can refer to the document: [Third-party dependency package installation](/guide/package-management/using-third-party-packages).
 
 #### Another simplified configuration syntax
 

+ 6 - 5
docs/api/description/project-target.md

@@ -1761,7 +1761,9 @@ target("demo")
 
 For more on this block, see: [add_deps](#add_deps)
 
-!>If you don't want it to be fixed in the project, you can set it by: xmake f --includedirs=xxx or xmake f --cxflags="-I/xxx". This manual setting has higher directory search priority.
+::: tip NOTE
+If you don't want it to be fixed in the project, you can set it by: xmake f --includedirs=xxx or xmake f --cxflags="-I/xxx". This manual setting has higher directory search priority.
+:::
 
 :::tip NOTE
 The header file does not support pattern matching by default, and it is not recommended to do so. It is easy to introduce some unnecessary subdirectories, resulting in the interference of various header file reference conflicts, and it is more difficult to check if there is a problem.
@@ -2118,8 +2120,6 @@ In this way, when compiling the test target, if the package exists, the macro de
 
 Users no longer need to call the [add_links](#add_links), [add_includedirs](#add_includedirs), [add_ldflags](#add_ldflags) interfaces to configure the dependent library links.
 
-For how to set up the package search directory, please refer to: [add_packagedirs](https://xmake.io/#/manual/global_interfaces?id=add_packagedirs) interface
-
 After v2.2.2, this interface also supports packages defined by [add_requires](/api/description/global-interfaces#add-requires) in remote dependency management.
 
 ```lua
@@ -2450,7 +2450,8 @@ In the above code example, it can be seen that when the target applies the markd
 In the rule script, you can get the extended flag value set in the target by `values("markdown.flags")`.
 
 :::tip NOTE
-The specific extension configuration name will be different according to different rules. Currently, you can refer to the description of related rules: [built-in rules](https://xmake.io/#/manual/custom_rule?id=built-in-rules)
+The specific extension configuration name will be different according to different rules. Currently,
+you can refer to the description of related rules: [built-in rules](/api/description/builtin-rules).
 :::
 
 The following is a list of some built-in extended configuration items currently supported by xmake.
@@ -3050,7 +3051,7 @@ target ("test")
     set_policy ("check.auto_ignore_flags", false)
 ```
 
-For a complete list of policies support and instructions, see: [build policies](https://xmake.io/#/guide/build_policies)
+For a complete list of policies support and instructions, see: [build policies](/api/description/builtin-policies).
 
 ## set_runtimes
 

+ 1 - 1
docs/examples/cpp/linux-driver-module.md

@@ -98,7 +98,7 @@ We only need to prepare our own cross-compilation tool chain, specify its root d
 
 The cross toolchain used here can be downloaded from here: [Download toolchains](https://releases.linaro.org/components/toolchain/binaries/latest-7/aarch64-linux-gnu/)
 
-For more, cross-compilation configuration documents, see: [Configure cross-compilation](https://xmake.io/#/guide/configuration?id=common-cross-compilation-configuration)
+For more, cross-compilation configuration documents, see: [Configure cross-compilation](/guide/basic-commands/cross-compilation).
 
 ::: tip NOTE
 Currently only supports arm/arm64 cross-compilation architecture, and more platform architectures will be supported in the future.

+ 1 - 1
docs/examples/cpp/wasm.md

@@ -6,7 +6,7 @@ $ xmake f -p wasm
 $ xmake
 ```
 
-For detailed wasm compilation configuration see: [wasm configuration](https://xmake.io/#/guide/configuration?id=wasm)
+For detailed wasm compilation configuration see: [wasm configuration](/guide/basic-commands/build-configuration#wasm-webassembly)
 
 Alternatively, when compiling a file with the `-preload-file assets/xxx.md` setting, we can also simplify its setup by configuring
 

+ 4 - 0
docs/guide/basic-commands/build-configuration.md

@@ -1,3 +1,7 @@
+---
+outline: deep
+---
+
 # Build Configuration
 
 Set compilation configuration before building project with command `xmake f|config`. If you want to known more options, please run: `xmake f --help`。

+ 6 - 4
docs/guide/best-practices/faq.md

@@ -67,7 +67,7 @@ Xmake.lua is divided into description fields and script fields. In the descripti
 
 If you want to write a variety of complex scripts, please configure them in the script domain. The script domain of `target/on_load` can also flexibly configure various target related settings and provide more powerful lua script module support.
 
-See: [Description of Syntax Description](https://xmake.io/#/guide/syntax_description) for more details.
+See: [Description of Syntax Description](/guide/project-configuration/syntax-description) for more details.
 
 ## How to debug Xmake source code?
 
@@ -103,7 +103,9 @@ $ tar -xvf xmake-v2.7.2.tar.gz -C xmake
 $ cd xmake
 ```
 
-! > The Xmake tarball does not have a top-level xmake root directory, so it is best to unpack it with `-C xmake` to specify the output directory.
+::: tip NOTE
+The Xmake tarball does not have a top-level xmake root directory, so it is best to unpack it with `-C xmake` to specify the output directory.
+:::
 
 ### Compiling source code
 
@@ -111,7 +113,7 @@ $ cd xmake
 
 If you are compiling Xmake source code on Windows, you will need to bootstrap it with an existing Xmake pre-build.
 
-Therefore we need to first install Xmake by referring to the [Installing Xmake on Windows](https://xmake.io/#/zh-cn/guide/installation?id=windows) documentation.
+Therefore we need to first install Xmake by referring to the [Installing Xmake on Windows](/guide/quick-start#windows) documentation.
 
 Then go to the Xmake source directory and compile.
 
@@ -253,7 +255,7 @@ This way, we can modify the xmake script source locally, sync it to a remote win
 
 We can also pull the remote files back to the local machine for analysis with the `xmake service --pull=` command.
 
-Note: See [Remote Build Documentation](http://xmake.io/#/features/remote_build) for a detailed description of remote build features.
+Note: See [Remote Build Documentation](/guide/extras/remote-compilation) for a detailed description of remote build features.
 
 ![](/assets/img/manual/xmake-remote.png)
 

+ 1 - 1
docs/guide/extensions/builtin-plugins.md

@@ -1026,7 +1026,7 @@ $ xmake pack --autobuild=n
 
 ### Interface description
 
-For more descriptions of the XPack packaging interface, see: [XPack Packaging Interface Document](https://xmake.io/#/manual/xpack).
+For more descriptions of the XPack packaging interface, see: [XPack Packaging Interface Document](/api/description/xpack-interfaces).
 
 ## Macros Recording and Playback
 

+ 3 - 2
docs/guide/extras/trybuild-3rd-sourcecode.md

@@ -141,7 +141,7 @@ $ xmake f -p cross --trybuild=[cmake|autotools] --sdk=/xxxx
 $ xmake
 ```
 
-For more cross compilation configuration details, please refer to the document: [Cross Compilation](https://xmake.io/#/guide/configuration?id=cross-compilation), except for an additional `--trybuild=` parameter, all other cross-compilation configuration parameters are completely universal.
+For more cross compilation configuration details, please refer to the document: [Cross Compilation](/guide/basic-commands/cross-compilation), except for an additional `--trybuild=` parameter, all other cross-compilation configuration parameters are completely universal.
 
 ## Passing user configuration parameters
 
@@ -178,4 +178,5 @@ $ xmake f -p android --trybuild=ndkbuild [--ndk =]
 $ xmake
 ```
 
-We also provided [xmake-gradle](https://github.com/xmake-io/xmake-gradle) to build jni library in gradle, you can see [Uses xmake to build JNI in Gradle](https://xmake.io/#/plugin/more_plugins?id=gradle-plugin-jni)
+We also provided [xmake-gradle](https://github.com/xmake-io/xmake-gradle) to build jni library in gradle,
+you can see [Uses xmake to build JNI in Gradle](/guide/extensions/ide-integration-plugins#gradle-plugin-jni)

+ 1 - 1
docs/guide/package-management/using-source-code-packages.md

@@ -53,7 +53,7 @@ Among them, we set the code directory location of the foo package through `set_s
 If only the local source code is integrated, we don't need to set additional `add_urls` and `add_versions`.
 :::
 
-For the configuration description of the package, see: [Package description description](https://xmake.io/#/package/remote_package?id=package-description).
+For the configuration description of the package, see: [Package description description](/guide/package-management/package-distribution.html#define-package-configuration).
 
 After defining the package, we can integrate it with `add_requires("foo")` and `add_packages("foo")`, just like integrating remote packages.
 

+ 2 - 2
docs/guide/package-management/xrepo-cli.md

@@ -14,13 +14,13 @@ And it also supports multi-version semantic selection. In addition, it is also a
 
 At the same time, xrepo also supports installing packages from third-party package managers such as vcpkg/homebrew/conan, and provides unified and consistent library link information to facilitate integration and docking with third-party projects.
 
-If you want to know more, please refer to: [Documents](https://xmake.io/#/home), [Github](https://github.com/xmake-io/xrepo) and [Gitee](https://gitee.com/tboox/xrepo). You can also [search packages here](https://xmake.microblock.cc).
+If you want to know more, please refer to: [Documents](https://xmake.io), [Github](https://github.com/xmake-io/xrepo) and [Gitee](https://gitee.com/tboox/xrepo). You can also [search packages here](https://xmake.microblock.cc).
 
 ![](https://github.com/xmake-io/xrepo-docs/raw/master/assets/img/xrepo.gif)
 
 ## Installation
 
-We only need install xmake to use the xrepo command. About the installation of xmake, we can see: [Xmake Installation Document](https://xmake.io/#/guide/installation).
+We only need install xmake to use the xrepo command. About the installation of xmake, we can see: [Xmake Installation Document](/guide/quick-start.html#installation).
 
 ## Supported platforms
 

+ 4 - 0
docs/guide/quick-start.md

@@ -1,3 +1,7 @@
+---
+outline: deep
+---
+
 # Quick Start
 
 ## Installation

+ 1 - 1
docs/zh/about/contact.md

@@ -1,6 +1,6 @@
 
 * 邮箱:[[email protected]](mailto:[email protected])
-* 主页:[xmake.io](https://xmake.io/#/zh-cn/)
+* 主页:[xmake.io](https://xmake.io/zh/)
 * 社区
   - [Reddit论坛](https://www.reddit.com/r/xmake/)
   - [Telegram群组](https://t.me/tbooxorg)

+ 1 - 1
docs/zh/about/sponsor.md

@@ -64,7 +64,7 @@ Xmake 项目属于个人开源项目,它的发展需要您的帮助,如果
 
 - All previous tier rewards
 - Add a logo and link to the README.md of my major open source projects
-- One-to-one technical consulting service, see [Technical Support](https://xmake.io/#/about/technical_support)
+- One-to-one technical consulting service
 
 ### $500 a month
 

+ 1 - 1
docs/zh/api/description/global-interfaces.md

@@ -414,7 +414,7 @@ please input: y (y/n)
 [100%]: linking.release test
 ```
 
-关于这个的完整介绍和所有第三方包的安装使用,可以参考文档:[第三方依赖包安装](https://xmake.io/#/zh-cn/package/remote_package?id=%e7%ac%ac%e4%b8%89%e6%96%b9%e4%be%9d%e8%b5%96%e5%8c%85%e5%ae%89%e8%a3%85)
+关于这个的完整介绍和所有第三方包的安装使用,可以参考文档:[第三方依赖包安装](/zh/guide/package-management/using-third-party-packages)。
 
 #### 另一种简化的配置语法
 

+ 1 - 1
docs/zh/api/description/package-dependencies.md

@@ -819,7 +819,7 @@ package("zlib")
 
 自定义下载需要用户完全自己控制下载逻辑,会比较复杂,除非必要,不推荐这么做。
 
-如果仅仅只是想增加自定义 http headers 去获取下载授权,可以使用 [设置包下载的 http headers](https://xmake.io/#/zh-cn/manual/project_target?id=%e8%ae%be%e7%bd%ae%e5%8c%85%e4%b8%8b%e8%bd%bd%e7%9a%84-http-headers)
+如果仅仅只是想增加自定义 http headers 去获取下载授权,可以使用 [设置包下载的 http headers](/zh/api/description/builtin-policies#package-download-http-headers)。
 
 ## on_component
 

+ 1 - 4
docs/zh/api/description/project-target.md

@@ -2107,8 +2107,6 @@ target("test")
 
 用户不再需要自己单独调用[add_links](#add_links),[add_includedirs](#add_includedirs), [add_ldflags](#add_ldflags)等接口,来配置依赖库链接了。
 
-对于如何设置包搜索目录,可参考:[add_packagedirs](https://xmake.io/#/zh-cn/manual/global_interfaces?id=add_packagedirs) 接口
-
 而在v2.2.2版本之后,此接口也同时支持远程依赖包管理中[add_requires](/zh/api/description/global-interfaces#add-requires)定义的包。
 
 ```lua
@@ -2440,7 +2438,7 @@ target("test")
 在规则脚本中可以通过`values("markdown.flags")`获取到target中设置的扩展flags值。
 
 :::tip 注意
-具体扩展配置名,根据不同的rule,会有所不同,目前有哪些,可以参考相关规则的描述:[内建规则](https://xmake.io/#/zh-cn/manual/custom_rule?id=内建规则)
+具体扩展配置名,根据不同的rule,会有所不同,目前有哪些,可以参考相关规则的描述:[内建规则](/zh/api/description/builtin-rules)。
 :::
 
 下面是一些 xmake 目前支持的一些内置的扩展配置项列表。
@@ -3043,7 +3041,6 @@ target("test")
     set_policy("check.auto_ignore_flags", false)
 ```
 
-完整的 policies 支持列表和使用说明,见:[构建策略](https://xmake.io/#/zh-cn/guide/build_policies)
 
 ## set_runtimes
 

+ 1 - 1
docs/zh/examples/cpp/linux-driver-module.md

@@ -98,7 +98,7 @@ target("hello")
 
 这里用到的交叉工具链,可以从这里下载: [Download toolchains](https://releases.linaro.org/components/toolchain/binaries/latest-7/aarch64-linux-gnu/)
 
-更多,交叉编译配置文档,见:[配置交叉编译](https://xmake.io/#/zh-cn/guide/configuration?id=common-cross-compilation-configuration)
+更多,交叉编译配置文档,见:[配置交叉编译](/zh/guide/basic-commands/cross-compilation)。
 
 ::: tip 注意
 目前仅仅支持 arm/arm64 交叉编译架构,后续会支持更多的平台架构。

+ 1 - 1
docs/zh/examples/cpp/wasm.md

@@ -5,7 +5,7 @@ $ xmake f -p wasm
 $ xmake
 ```
 
-详细的 Wasm 编译配置见:[Wasm 配置](https://xmake.io/#/zh-cn/guide/configuration?id=wasm)
+详细的 Wasm 编译配置见:[Wasm 配置](/zh/guide/basic-commands/build-configuration.html#wasm-webassembly)。
 
 另外,在编译带有 `--preload-file assets/xxx.md` 设置的文件时候,我们也可以通过配置,简化对它的设置。
 

+ 4 - 0
docs/zh/guide/basic-commands/build-configuration.md

@@ -1,3 +1,7 @@
+---
+outline: deep
+---
+
 # 编译配置 {#build-configuration}
 
 通过`xmake f|config`配置命令,设置构建前的相关配置信息,详细参数选项,请运行: `xmake f --help`。

+ 3 - 3
docs/zh/guide/best-practices/faq.md

@@ -69,7 +69,7 @@ xmake.lua里面分描述域和脚本域,在描述域里面会对各种配置
 
 如果要写各种复杂脚本,请在脚本域内进行配置,`target/on_load`的脚本域里面同样可以灵活配置各种target相关设置,并且提供更强大的lua脚本模块支持。
 
-更多细节见:[描述语法说明](https://xmake.io/#/zh-cn/guide/syntax_description)
+更多细节见:[描述语法说明](/zh/guide/project-configuration/syntax-description)。
 
 ## 如何调试 Xmake 源码? {#debugging-xmake-sourcecode}
 
@@ -115,7 +115,7 @@ Xmake 的 tar 源码包没有顶层 xmake 根目录,因此解压时候最好
 
 如果是在 Windows 编译 Xmake 源码,需要借助现有的 Xmake 预构建版本进行自举编译。
 
-因此我们需要先参考 [Windows 安装 Xmake](https://xmake.io/#/zh-cn/guide/installation?id=windows) 文档,安装 Xmake。
+因此我们需要先参考 [Windows 安装 Xmake](/zh/guide/quick-start#windows) 文档,安装 Xmake。
 
 然后进入 Xmake 源码目录进行编译。
 
@@ -259,7 +259,7 @@ $ xmake run
 
 我们也能够通过 `xmake service --pull=` 命令,回拉远程的文件到本地,进行分析。
 
-注:详细的远程编译特性说明,见 [远程编译文档](http://xmake.io/#/zh-cn/features/remote_build)。
+注:详细的远程编译特性说明,见 [远程编译文档](/zh/guide/extras/remote-compilation)。
 
 ![](/assets/img/manual/xmake-remote.png)
 

+ 1 - 1
docs/zh/guide/extensions/builtin-plugins.md

@@ -1042,7 +1042,7 @@ $ xmake pack --autobuild=n
 
 ### 接口描述
 
-更多 XPack 打包接口描述见:[XPack 打包接口文档](https://xmake.io/#/zh-cn/manual/xpack)。
+更多 XPack 打包接口描述见:[XPack 打包接口文档](/zh/api/description/xpack-interfaces)。
 
 ## 宏记录和回放 {#xmake-macro}
 

+ 11 - 11
docs/zh/guide/extensions/ide-integration-plugins.md

@@ -1,6 +1,6 @@
 # IDE 集成插件 {#ide-integration-plugins}
 
-## VSCode 插件
+## VSCode 插件 {#vscode-plugin}
 
 * [xmake-vscode](https://github.com/xmake-io/xmake-vscode)
 
@@ -38,13 +38,13 @@
 
 其他xmake的选项也同样可以在settings.json中完成设置。修改后可通过 >XMake: Configure 命令刷新配置。
 
-### 配置 Intellsence
+### 配置 IntelliSense {#intellisense}
 
 为了更好的 C++ 语法提示体验,xmake提供了对[Language Server Protocol](https://microsoft.github.io/language-server-protocol/)(简称LSP)的支持。
 
-在 vscode 中,我们可以通过使用 vscode-cpptools 或者 clangd 来提供 intellsence 支持。
+在 vscode 中,我们可以通过使用 vscode-cpptools 或者 clangd 来提供 intellisense 支持。
 
-另外,为了支持 intellsence,xmake 提供了 compile_commands.json 的生成支持。
+另外,为了支持 intellisense,xmake 提供了 compile_commands.json 的生成支持。
 
 #### 生成 compile_commands
 
@@ -81,9 +81,9 @@ $ xmake project -k compile_commands .vscode
 
 #### vscode-cpptools
 
-如果我们使用 vscode-cpptools 插件来提供 intellsence 支持,需要先去 vscode 插件市场,搜下 C++,默认第一个插件就是,安装下。
+如果我们使用 vscode-cpptools 插件来提供 intellisense 支持,需要先去 vscode 插件市场,搜下 C++,默认第一个插件就是,安装下。
 
-装完后,这个插件提供了 intellsence 和 调试支持。
+装完后,这个插件提供了 intellisense 和 调试支持。
 
 然后,我们需要配置下 c_cpp_properties.json 文件,关联上我们生成的 `.vscode/compile_commands.json`。
 
@@ -161,23 +161,23 @@ $ xmake project -k compile_commands .vscode
 
 如果配置后,还是没生效,可以尝试重启 vscode 和 clangd 进程,再验证下。
 
-## Sublime 插件
+## Sublime 插件 {#sublime-plugin}
 
 * [xmake-sublime](https://github.com/xmake-io/xmake-sublime)
 
 <img src="https://raw.githubusercontent.com/xmake-io/xmake-sublime/master/res/problem.gif" width="650px" />
 
-## Intellij IDEA/CLion 插件
+## Intellij IDEA/CLion 插件 {#clion-plugin}
 
 * [xmake-idea](https://github.com/xmake-io/xmake-idea)
 
 <img src="https://raw.githubusercontent.com/xmake-io/xmake-idea/master/res/problem.gif" width="650px" />
 
-## Vim 插件
+## Vim 插件 {#vim-plugin}
 
 * [xmake.vim](https://github.com/luzhlon/xmake.vim) (第三方开发, 感谢[@luzhlon](https://github.com/luzhlon))
 
-## Neovim 插件
+## Neovim 插件 {#neovim-plugin}
 
 * [xmake.nvim](https://github.com/Mythos-404/xmake.nvim) (第三方开发, 感谢[@Mythos_404](https://github.com/Mythos-404))
 
@@ -185,7 +185,7 @@ $ xmake project -k compile_commands .vscode
 
 <img src="https://raw.githubusercontent.com/Mythos-404/xmake.nvim/main/assets/XmakePreview.gif" width="650px" />
 
-## Gradle插件(JNI)
+## Gradle插件(JNI){#gradle-plugin}
 
 * [xmake-gradle](https://github.com/xmake-io/xmake-gradle): 一个无缝整合xmake的gradle插件
 

+ 3 - 2
docs/zh/guide/extras/trybuild-3rd-sourcecode.md

@@ -147,7 +147,7 @@ $ xmake f -p cross --trybuild=[cmake|autotools] --sdk=/xxxx
 $ xmake
 ```
 
-关于更多交叉编译的配置细节,请参考文档:[交叉编译](https://xmake.io/#/zh-cn/guide/configuration?id=%e4%ba%a4%e5%8f%89%e7%bc%96%e8%af%91),除了多了一个`--trybuild=`参数,其他交叉编译配置参数都是完全通用的。
+关于更多交叉编译的配置细节,请参考文档:[交叉编译](/zh/guide/basic-commands/cross-compilation),除了多了一个`--trybuild=`参数,其他交叉编译配置参数都是完全通用的。
 
 ## 传递用户配置参数
 
@@ -186,4 +186,5 @@ $ xmake f -p android --trybuild=ndkbuild [--ndk=]
 $ xmake
 ```
 
-如果觉得命令行编译jni比较麻烦,xmake也提供了相关的gradle集成插件[xmake-gradle](https://github.com/xmake-io/xmake-gradle),可以无缝集成xmake进行jni库的编译集成,具体详情见:[使用xmake-gradle插件构建JNI程序](https://xmake.io/#/zh-cn/plugin/more_plugins?id=gradle%e6%8f%92%e4%bb%b6%ef%bc%88jni%ef%bc%89)
+如果觉得命令行编译jni比较麻烦,xmake也提供了相关的gradle集成插件[xmake-gradle](https://github.com/xmake-io/xmake-gradle),
+可以无缝集成xmake进行jni库的编译集成,具体详情见:[使用xmake-gradle插件构建JNI程序](/zh/guide/extensions/ide-integration-plugins.html#gradle-plugin)。

+ 1 - 1
docs/zh/guide/package-management/using-source-code-packages.md

@@ -53,7 +53,7 @@ target("demo")
 如果仅仅本地源码集成,我们不需要额外设置 `add_urls` 和 `add_versions`。
 :::
 
-关于包的配置描述,详情见:[包描述说明](https://xmake.io/#/zh-cn/package/remote_package?id=%e5%8c%85%e6%8f%8f%e8%bf%b0%e8%af%b4%e6%98%8e)
+关于包的配置描述,详情见:[包描述说明](/zh/guide/package-management/package-distribution.html#define-package-configuration)。
 
 定义完包后,我们就可以通过 `add_requires("foo")` 和 `add_packages("foo")` 来集成使用它了,就跟集成远程包一样的使用方式。
 

+ 2 - 2
docs/zh/guide/package-management/xrepo-cli.md

@@ -14,13 +14,13 @@ Xrepo 是一个基于 [Xmake](https://github.com/xmake-io/xmake) 的跨平台 C/
 
 同时,xrepo 也支持从 vcpkg/homebrew/conan 等第三方包管理器中安装包,并提供统一一致的库链接信息,方便与第三方项目的集成对接。
 
-如果你想要了解更多,请参考:[在线文档](https://xmake.io/#/zh-cn/getting_started), [Github](https://github.com/xmake-io/xrepo) 以及 [Gitee](https://gitee.com/tboox/xrepo)
+如果你想要了解更多,请参考:[在线文档](https://xmake.io/zh/), [Github](https://github.com/xmake-io/xrepo) 以及 [Gitee](https://gitee.com/tboox/xrepo)
 
 ![](https://github.com/xmake-io/xrepo-docs/raw/master/assets/img/xrepo.gif)
 
 ## 安装
 
-我们只需要安装上 xmake 就可以使用 xrepo 命令,关于 xmake 的安装,我们可以看下:[xmake 安装文档](https://xmake.io/#/zh-cn/guide/installation)。
+我们只需要安装上 xmake 就可以使用 xrepo 命令,关于 xmake 的安装,我们可以看下:[Xmake 安装文档](/zh/guide/quick-start.html#installation)。
 
 ## 支持平台
 

+ 4 - 0
docs/zh/guide/quick-start.md

@@ -1,3 +1,7 @@
+---
+outline: deep
+---
+
 # 快速上手 {quick-start}
 
 ## 安装 {#installation}