aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2019-06-23 20:48:18 +0800
committerruki <waruqi@gmail.com>2019-06-23 20:48:18 +0800
commit6f7387e12aeac26276b520137101b7f97f1d2ada (patch)
treec8de5db2504e159eb6abcb63d705d338db44d4d1
parent4ac242122f78a558d5c2fbc9a13a3c5282887524 (diff)
downloadxmake-docs-6f7387e12aeac26276b520137101b7f97f1d2ada.tar.gz
xmake-docs-6f7387e12aeac26276b520137101b7f97f1d2ada.zip
fix some links
-rw-r--r--_coverpage.md7
-rw-r--r--about/introduction.md1
-rw-r--r--getting_started.md (renamed from README.md)0
-rw-r--r--guide/package_management.md8
-rw-r--r--guide/syntax_description.md4
-rw-r--r--zh-cn/_coverpage.md5
-rw-r--r--zh-cn/getting_started.md (renamed from zh-cn/README.md)0
-rw-r--r--zh-cn/guide/package_management.md6
-rw-r--r--zh-cn/guide/syntax_description.md4
9 files changed, 17 insertions, 18 deletions
diff --git a/_coverpage.md b/_coverpage.md
index 810257dc..4403a894 100644
--- a/_coverpage.md
+++ b/_coverpage.md
@@ -4,9 +4,8 @@
> A cross-platform build utility based on Lua
-- Simple grammar, get started quickly
-- Cross-platform build, full platform coverage
-- Modern C/C++ build tools, multi-language hybrid compilation support
+- Simple, Fast, Cross-platform
+- Modern C/C++ build tools, Support multi-language hybrid compilation
[github](https://github.com/xmake-io/xmake/)
-[Getting Started](/guide/installation)
+[Getting Started](/getting_started)
diff --git a/about/introduction.md b/about/introduction.md
index 3454127b..400756d3 100644
--- a/about/introduction.md
+++ b/about/introduction.md
@@ -3,3 +3,4 @@ xmake is a cross-platform build utility based on lua.
The project focuses on making development and building easier and provides many features (.e.g package, install, plugin, macro, action, option, task ...),
so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.
+
diff --git a/README.md b/getting_started.md
index 35d70644..35d70644 100644
--- a/README.md
+++ b/getting_started.md
diff --git a/guide/package_management.md b/guide/package_management.md
index 9e0f853a..169b7aa5 100644
--- a/guide/package_management.md
+++ b/guide/package_management.md
@@ -21,7 +21,7 @@ If you want the current project to recognize loading these packages, you first n
add_packagedirs("packages")
```
-Once specified, you can add integration package dependencies in the target scope via the [add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages) interface, for example:
+Once specified, you can add integration package dependencies in the target scope via the [add_packages](/manual/project_target?id=targetadd_packages) interface, for example:
```lua
target("tbox")
@@ -42,13 +42,13 @@ $ cd tbox
$ xmake package -o ../test/packages
```
-In this way, the test project can pass [add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages) and [add_packagedirs](https://xmake.io/#/zh/manual?id=add_packagedirs) to configure and use the tbox.pkg package.
+In this way, the test project can pass [add_packages](/manual/project_target?id=targetadd_packages) and [add_packagedirs](/manual/global_interfaces?id=add_packagedirs) to configure and use the tbox.pkg package.
For a detailed description of the built-in package, you can also refer to the following related article, which is described in detail: [Dependency package addition and automatic detection mechanism](https://tboox.org/cn/2016/08/06/add-package-and-autocheck/)
## System Search Mode
-If you feel that the above built-in package management method is very inconvenient, you can use the extension interface [lib.detect.find_package](https://xmake.io/#/zh/manual?id=detect-find_package) to find the system. Existing dependencies.
+If you feel that the above built-in package management method is very inconvenient, you can use the extension interface [lib.detect.find_package](/manual/extension_modules?id=detectfind_package) to find the system. Existing dependencies.
Currently this interface supports the following package management support:
@@ -92,7 +92,7 @@ target("test")
If third-party tools such as `homebrew`, `pkg-config` are installed on the system, then this interface will try to use them to improve the search results.
-For a more complete description of the usage, please refer to the [find_packages](https://xmake.io/#/en/manual?id=find_packages) interface documentation.
+For a more complete description of the usage, please refer to the [find_packages](/manual/builtin_modules?id=find_packages) interface documentation.
### Homebrew Integration Support
diff --git a/guide/syntax_description.md b/guide/syntax_description.md
index b23aab44..88c1a188 100644
--- a/guide/syntax_description.md
+++ b/guide/syntax_description.md
@@ -79,7 +79,7 @@ The current external scope lating lua built-in apis are:
- print
- os
-Of course, although the built-in lua api does not provide much, xmake also provides a lot of extension APIs. It is not much to describe the api. For details, please refer to: [API Manual] (https://xmake.io/#/zh/manual)
+Of course, although the built-in lua api does not provide much, xmake also provides a lot of extension APIs. It is not much to describe the api. For details, please refer to: [API Manual](/manual)
There are also some auxiliary apis, for example:
@@ -135,7 +135,7 @@ task("hello")
In this scope, not only can you use most lua apis, but you can also use many extension modules provided by xmake. All extension modules are imported through import.
-For details, please refer to: [import module document](https://xmake.io/#/zh/manual?id=import)
+For details, please refer to: [import module document](/manual/builtin_modules?id=import)
Here we give a simple example, after the compilation is complete, ldid signature on the ios target program:
diff --git a/zh-cn/_coverpage.md b/zh-cn/_coverpage.md
index 80098b33..ad280313 100644
--- a/zh-cn/_coverpage.md
+++ b/zh-cn/_coverpage.md
@@ -4,9 +4,8 @@
> 一个基于Lua的轻量级跨平台自动构建工具
-- 语法简洁,快速上手
-- 跨平台构建,全平台覆盖
+- 简单,快速,跨平台
- 现代化的C/C++构建工具,多语言混合编译支持
[GitHub](https://github.com/xmake-io/xmake/)
-[快速开始](/zh-cn/guide/installation)
+[快速开始](/zh-cn/getting_started)
diff --git a/zh-cn/README.md b/zh-cn/getting_started.md
index 8d0b861c..8d0b861c 100644
--- a/zh-cn/README.md
+++ b/zh-cn/getting_started.md
diff --git a/zh-cn/guide/package_management.md b/zh-cn/guide/package_management.md
index 6f1a8188..02a8e280 100644
--- a/zh-cn/guide/package_management.md
+++ b/zh-cn/guide/package_management.md
@@ -21,7 +21,7 @@
add_packagedirs("packages")
```
-指定好后,就可以在target作用域中,通过[add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages)接口,来添加集成包依赖了,例如:
+指定好后,就可以在target作用域中,通过[add_packages](/zh-cn/manual/project_target?id=targetadd_packages)接口,来添加集成包依赖了,例如:
```lua
target("tbox")
@@ -42,7 +42,7 @@ $ cd tbox
$ xmake package -o ../test/packages
```
-这样,test工程就可以通过[add_packages](https://xmake.io/#/zh/manual?id=targetadd_packages)和[add_packagedirs](https://xmake.io/#/zh/manual?id=add_packagedirs)去配置和使用tbox.pkg包了。
+这样,test工程就可以通过[add_packages]((/zh-cn/manual/project_target?id=targetadd_packages)和[add_packagedirs](/zh-cn/manual/global_interfaces?id=add_packagedirs)去配置和使用tbox.pkg包了。
关于内置包的详细描述,还可以参考下相关文章,这里面有详细介绍:[依赖包的添加和自动检测机制](https://tboox.org/cn/2016/08/06/add-package-and-autocheck/)
@@ -92,7 +92,7 @@ target("test")
如果系统上装有`homebrew`, `pkg-config`等第三方工具,那么此接口会尝试使用它们去改进查找结果。
-更完整的使用描述,请参考:[find_packages](https://xmake.io/#/zh/manual?id=find_packages)接口文档。
+更完整的使用描述,请参考:[find_packages](/zh-cn/manual/builtin_modules?id=find_packages)接口文档。
##### homebrew集成支持
diff --git a/zh-cn/guide/syntax_description.md b/zh-cn/guide/syntax_description.md
index 92232946..30fe5f80 100644
--- a/zh-cn/guide/syntax_description.md
+++ b/zh-cn/guide/syntax_description.md
@@ -79,7 +79,7 @@ target("demo")
- print
- os
-当然虽然内置lua api提供不多,但xmake还提供了很多扩展api,像描述api就不多说,详细可参考:[API手册](https://xmake.io/#/zh/manual)
+当然虽然内置lua api提供不多,但xmake还提供了很多扩展api,像描述api就不多说,详细可参考:[API手册](/zh-cn/manual)
还有些辅助api,例如:
@@ -135,7 +135,7 @@ task("hello")
在此作用域中,不仅可以使用大部分lua的api,还可以使用很多xmake提供的扩展模块,所有扩展模块,通过import来导入
-具体可参考:[import模块导入文档](https://xmake.io/#/zh/manual?id=import)
+具体可参考:[import模块导入文档](/zh-cn/manual/builtin_modules?id=import)
这里我们给个简单的例子,在编译完成后,对ios目标程序进行ldid签名: