ruki 2 місяців тому
батько
коміт
eb5d470f20
66 змінених файлів з 2591 додано та 5 видалено
  1. 36 0
      docs/api/description/conditions.md
  2. 66 0
      docs/api/description/configuration-option.md
  3. 117 0
      docs/api/description/custom-rule.md
  4. 24 0
      docs/api/description/custom-toolchain.md
  5. 57 0
      docs/api/description/global-interfaces.md
  6. 90 0
      docs/api/description/package-dependencies.md
  7. 225 0
      docs/api/description/project-target.md
  8. 36 0
      docs/api/description/xpack-component-interfaces.md
  9. 120 0
      docs/api/description/xpack-interfaces.md
  10. 18 0
      docs/api/scripts/builtin-modules/coroutine.md
  11. 3 0
      docs/api/scripts/builtin-modules/cprint.md
  12. 3 0
      docs/api/scripts/builtin-modules/cprintf.md
  13. 3 0
      docs/api/scripts/builtin-modules/format.md
  14. 39 0
      docs/api/scripts/builtin-modules/hash.md
  15. 3 0
      docs/api/scripts/builtin-modules/import.md
  16. 3 0
      docs/api/scripts/builtin-modules/inherit.md
  17. 42 0
      docs/api/scripts/builtin-modules/io.md
  18. 3 0
      docs/api/scripts/builtin-modules/ipairs.md
  19. 9 0
      docs/api/scripts/builtin-modules/linuxos.md
  20. 3 0
      docs/api/scripts/builtin-modules/macos.md
  21. 189 0
      docs/api/scripts/builtin-modules/os.md
  22. 3 0
      docs/api/scripts/builtin-modules/pairs.md
  23. 54 0
      docs/api/scripts/builtin-modules/path.md
  24. 3 0
      docs/api/scripts/builtin-modules/print.md
  25. 3 0
      docs/api/scripts/builtin-modules/printf.md
  26. 3 0
      docs/api/scripts/builtin-modules/raise.md
  27. 9 0
      docs/api/scripts/builtin-modules/signal.md
  28. 18 0
      docs/api/scripts/builtin-modules/string.md
  29. 18 0
      docs/api/scripts/builtin-modules/table.md
  30. 3 0
      docs/api/scripts/builtin-modules/vformat.md
  31. 12 0
      docs/api/scripts/builtin-modules/winos.md
  32. 12 0
      docs/api/scripts/extension-modules/async/jobgraph.md
  33. 3 0
      docs/api/scripts/extension-modules/async/runjobs.md
  34. 36 0
      docs/zh/api/description/conditions.md
  35. 66 0
      docs/zh/api/description/configuration-option.md
  36. 117 0
      docs/zh/api/description/custom-rule.md
  37. 24 0
      docs/zh/api/description/custom-toolchain.md
  38. 57 0
      docs/zh/api/description/global-interfaces.md
  39. 90 0
      docs/zh/api/description/package-dependencies.md
  40. 225 0
      docs/zh/api/description/project-target.md
  41. 36 0
      docs/zh/api/description/xpack-component-interfaces.md
  42. 120 0
      docs/zh/api/description/xpack-interfaces.md
  43. 18 0
      docs/zh/api/scripts/builtin-modules/coroutine.md
  44. 3 0
      docs/zh/api/scripts/builtin-modules/cprint.md
  45. 3 0
      docs/zh/api/scripts/builtin-modules/cprintf.md
  46. 3 0
      docs/zh/api/scripts/builtin-modules/format.md
  47. 39 0
      docs/zh/api/scripts/builtin-modules/hash.md
  48. 3 0
      docs/zh/api/scripts/builtin-modules/import.md
  49. 3 0
      docs/zh/api/scripts/builtin-modules/inherit.md
  50. 42 0
      docs/zh/api/scripts/builtin-modules/io.md
  51. 3 0
      docs/zh/api/scripts/builtin-modules/ipairs.md
  52. 9 0
      docs/zh/api/scripts/builtin-modules/linuxos.md
  53. 3 0
      docs/zh/api/scripts/builtin-modules/macos.md
  54. 344 5
      docs/zh/api/scripts/builtin-modules/os.md
  55. 3 0
      docs/zh/api/scripts/builtin-modules/pairs.md
  56. 30 0
      docs/zh/api/scripts/builtin-modules/path.md
  57. 3 0
      docs/zh/api/scripts/builtin-modules/print.md
  58. 3 0
      docs/zh/api/scripts/builtin-modules/printf.md
  59. 3 0
      docs/zh/api/scripts/builtin-modules/raise.md
  60. 9 0
      docs/zh/api/scripts/builtin-modules/signal.md
  61. 18 0
      docs/zh/api/scripts/builtin-modules/string.md
  62. 18 0
      docs/zh/api/scripts/builtin-modules/table.md
  63. 3 0
      docs/zh/api/scripts/builtin-modules/vformat.md
  64. 12 0
      docs/zh/api/scripts/builtin-modules/winos.md
  65. 12 0
      docs/zh/api/scripts/extension-modules/async/jobgraph.md
  66. 3 0
      docs/zh/api/scripts/extension-modules/async/runjobs.md

+ 36 - 0
docs/api/description/conditions.md

@@ -8,9 +8,12 @@ Conditions are generally used to handle some special compilation platforms.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_os(os: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -41,9 +44,12 @@ Support operation systems:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_arch(arch: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -83,9 +89,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_plat(plat: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -137,9 +146,12 @@ Available platforms:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_host(host: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -176,9 +188,12 @@ We can also get it from [$(host)](/api/description/builtin-variables#var-host) o
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_subhost(subhost: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -216,9 +231,12 @@ It may also support other subsystem environments under linux and macos systems l
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_subarch(subarch: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -240,9 +258,12 @@ We can also quickly view the current subsystem architecture by executing `xmake
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_cross()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -260,9 +281,12 @@ This interface returns true if the current target architecture and platform, whi
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_mode(mode: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -300,9 +324,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_kind(kind: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -348,9 +375,12 @@ $ xmake
 
 #### Function Prototype
 
+::: tip API
 ```lua
 is_config(name: <string>, values: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -415,9 +445,12 @@ but also to determine the built-in global and local configuration.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 has_config(configs: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -470,9 +503,12 @@ This interface works together with the [get_config](/api/description/global-inte
 
 #### Function Prototype
 
+::: tip API
 ```lua
 has_package(packages: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 66 - 0
docs/api/description/configuration-option.md

@@ -32,9 +32,12 @@ The `option` field can be repeatedly entered to implement separate settings. If
 
 #### Function Prototype
 
+::: tip API
 ```lua
 option(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -75,9 +78,12 @@ $ xmake
 
 #### Function Prototype
 
+::: tip API
 ```lua
 option_end()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -95,9 +101,12 @@ This is an optional api that shows the departure option scope, similar to [targe
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -139,9 +148,12 @@ Execute this script before option detection
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_check(script: <function (option)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -163,9 +175,12 @@ option("zlib")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_check(script: <function (option)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -199,9 +214,12 @@ Execute this script after option detection
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_check(script: <function (option)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -228,9 +246,12 @@ option("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_values(values: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -259,9 +280,12 @@ The effect chart is as follows:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_default(value: <string|boolean|number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -331,9 +355,12 @@ Detection behavior of the
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_showmenu(showmenu: <boolean>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -369,9 +396,12 @@ After 2.6.8, this option is enabled by default and there is usually no need to c
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_category(category: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -458,9 +488,12 @@ The effect chart is as follows:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_description(description: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -523,9 +556,12 @@ $ xmake f --mode=release
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_links(links: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -556,9 +592,12 @@ If the test passes, the `test` target will be automatically added when it is com
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_linkdirs(linkdirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -577,9 +616,12 @@ This is optional. Generally, the system library does not need to add this, and i
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_rpathdirs(rpathdirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -598,9 +640,12 @@ After the option passes the detection, it will be automatically added to the cor
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cincludes(includes: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -632,9 +677,12 @@ If you want more flexible detection, you can do this in [option.on_check](#on_ch
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cxxincludes(includes: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -653,9 +701,12 @@ Similar to [add_cincludes](#add_cincludes), except that the detected header file
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_ctypes(types: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -687,9 +738,12 @@ If you want more flexible detection, you can do this in [option.on_check](#on_ch
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cxxtypes(types: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -708,6 +762,7 @@ Similar to [add_ctypes](#add_ctypes), except that the type detected is a c++ typ
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_csnippets(name: <string>, code: <string>, {
     tryrun = <boolean>,
@@ -715,6 +770,8 @@ add_csnippets(name: <string>, code: <string>, {
     number = <boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -737,6 +794,7 @@ You can use this interface to implement more custom detection of some compiler f
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cxxsnippets(name: <string>, code: <string>, {
     tryrun = <boolean>,
@@ -744,6 +802,8 @@ add_cxxsnippets(name: <string>, code: <string>, {
     number = <boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -806,9 +866,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cfuncs(funcs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -854,9 +917,12 @@ Note that the detected function usually needs to be accompanied by `add_cinclude
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_cxxfuncs(funcs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 117 - 0
docs/api/description/custom-rule.md

@@ -100,9 +100,12 @@ Rules specified by `add_files("*.md", {rules = "markdown"})`, with a higher prio
 
 #### Function Prototype
 
+::: tip API
 ```lua
 rule(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -126,11 +129,14 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ..., {
     order = <boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -210,9 +216,12 @@ target("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_imports(modules: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -231,9 +240,12 @@ For usage and description, please see: [target:add_imports](/api/description/pro
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_extensions(extensions: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -271,9 +283,12 @@ target("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_load(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -298,9 +313,12 @@ rule("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_config(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -326,9 +344,12 @@ on_load -> after_load -> on_config -> before_build -> on_build -> after_build
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_link(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -352,9 +373,12 @@ rule("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_build(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -378,9 +402,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_clean(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -405,9 +432,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_package(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -432,9 +462,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_install(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -458,9 +491,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -484,9 +520,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -511,9 +550,12 @@ The third parameter opt is an optional parameter, which is used to obtain some i
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -596,9 +638,12 @@ For a detailed description and background of this, see: [issue 1246](https://git
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -630,9 +675,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -660,9 +708,12 @@ rule("foo")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_config(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -688,9 +739,12 @@ It will be executed before on_config.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_link(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -714,9 +768,12 @@ rule("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_build(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -740,9 +797,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_clean(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -766,9 +826,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_package(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -792,9 +855,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_install(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -818,9 +884,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -844,9 +913,12 @@ rule("markdown")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -865,9 +937,12 @@ Generally used to preprocess some source files before compiling.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -886,9 +961,12 @@ It is generally used to pre-process certain source files before compilation.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -907,9 +985,12 @@ It is generally used to pre-process certain source files before compilation.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -928,9 +1009,12 @@ It is generally used to pre-process certain source files before compilation.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_config(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -956,9 +1040,12 @@ It will be executed after on_config.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_link(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -976,9 +1063,12 @@ The execution script used to implement the custom target link is similar to [aft
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_build(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -996,9 +1086,12 @@ The execution script used to implement the custom target build is similar to [be
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_clean(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1016,9 +1109,12 @@ The execution script used to implement the custom target cleanup is similar to [
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_package(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1036,9 +1132,12 @@ The execution script used to implement the custom target package is similar to [
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_install(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1056,9 +1155,12 @@ The execution script used to implement the custom target installation is similar
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1076,9 +1178,12 @@ The execution script used to implement the custom target uninstallation is simil
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1097,9 +1202,12 @@ Generally used to post-process some compiled object files.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1118,9 +1226,12 @@ Generally used for post-processing some compiled object files.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1139,9 +1250,12 @@ Generally used for post-processing some compiled object files.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1160,9 +1274,12 @@ Generally used for post-processing some compiled object files.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 rule_end()
 ```
+:::
+
 
 #### Parameter Description
 

+ 24 - 0
docs/api/description/custom-toolchain.md

@@ -79,9 +79,12 @@ $ xmake show -l toolchains
 
 #### Function Prototype
 
+::: tip API
 ```lua
 toolchain(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -202,9 +205,12 @@ For more examples of custom toolchains, we can see the following interface docum
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_kind(kind: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -230,9 +236,12 @@ Just remember that the toolchain with a complete compilation environment is set
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_toolset(tool: <string>, tools: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -283,9 +292,12 @@ For details about this interface, you can see: [target.set_toolset](/api/descrip
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_sdkdir(sdkdir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -310,9 +322,12 @@ toolchain("myclang")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_bindir(bindir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -337,9 +352,12 @@ toolchain("myclang")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_check(script: <function (toolchain)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -366,9 +384,12 @@ toolchain("myclang")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_load(script: <function (toolchain)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -403,9 +424,12 @@ toolchain("myclang")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 toolchain_end()
 ```
+:::
+
 
 #### Parameter Description
 

+ 57 - 0
docs/api/description/global-interfaces.md

@@ -8,11 +8,14 @@ The global interface affects the whole project description scope and all sub-pro
 
 #### Function Prototype
 
+::: tip API
 ```lua
 includes(paths: <string|array>, ..., {
     rootdir = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -185,9 +188,12 @@ Also, target scope configurations can be added repeatedly. In many cases, you do
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_project(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -213,12 +219,15 @@ set_version("1.5.1")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_version(version: <string>, {
     build = <string>,
     soname = <string|boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -288,9 +297,12 @@ set_version("1.0.1") -> libfoo.so, libfoo.dylib
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_xmakever(version: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -313,9 +325,12 @@ set_xmakever("2.1.0")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_moduledirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -339,9 +354,12 @@ xmake will load the given module in the given directory when calling [`import`](
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_plugindirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -365,9 +383,12 @@ xmake will load all plugins in the given directory.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 get_config(name: <string>): <string|boolean|number>
 ```
+:::
+
 
 #### Parameter Description
 
@@ -395,9 +416,12 @@ This interface can get not only the custom configuration option values defined t
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_config(name: <string>, value: <string|boolean|number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -428,6 +452,7 @@ However, we can still modify the default configuration in xmake.lua by `$xmake f
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_requires(packages: <string|array>, ..., {
     optional = <boolean>,
@@ -440,6 +465,8 @@ add_requires(packages: <string|array>, ..., {
     ... = <any>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -695,6 +722,7 @@ add_requires("ffmpeg[shared,debug,codecs=[foo,bar,zoo]]")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_requireconfs(packages: <string|array>, ..., {
     configs = <table>,
@@ -704,6 +732,8 @@ add_requireconfs(packages: <string|array>, ..., {
     ... = <any>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -838,11 +868,14 @@ add_requireconfs("libwebp.*|cmake", {debug = true})
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_repositories(repos: <string|array>, ..., {
     rootdir = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -900,9 +933,12 @@ However, this parameter setting is only supported by v2.5.7 and above.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_defaultplat(platform: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -928,9 +964,12 @@ It is equivalent to `xmake f -p iphoneos`.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_defaultarchs(archs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -964,9 +1003,12 @@ The arm64 architecture is compiled by default on iphoneos, and the x64 architect
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_defaultmode(mode: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -990,9 +1032,12 @@ It is equivalent to `xmake f -m releasedbg`.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_allowedplats(platforms: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1019,9 +1064,12 @@ Set the current project to only support windows and mingw platforms.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_allowedarchs(archs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1056,9 +1104,12 @@ Set the current project to only support x64 architecture on windows, and only su
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_allowedmodes(modes: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1085,9 +1136,12 @@ Set the current project to only support the two compilation modes release/releas
 
 #### Function Prototype
 
+::: tip API
 ```lua
 namespace(name: <string>, script: <function>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1399,9 +1453,12 @@ end)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 namespace_end()
 ```
+:::
+
 
 #### Parameter Description
 

+ 90 - 0
docs/api/description/package-dependencies.md

@@ -6,9 +6,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 package(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -64,9 +67,12 @@ package("libxml2")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_homepage(url: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -84,9 +90,12 @@ Set the official page address of the project where the package is located.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -104,11 +113,14 @@ Set the package description information, generally see the relevant package info
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_kind(kind: <string>, {
     headeronly = <boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -181,6 +193,7 @@ target("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_urls(urls: <string|array>, ..., {
     excludes = <array>,
@@ -188,6 +201,8 @@ set_urls(urls: <string|array>, ..., {
     http_headers = <array>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -209,6 +224,7 @@ Set the source package or git repository address of the package. Unlike add_urls
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_urls(urls: <string|array>, ..., {
     alias = <string>,
@@ -217,6 +233,8 @@ add_urls(urls: <string|array>, ..., {
     http_headers = <array>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -283,9 +301,12 @@ add_urls("https://github.com/madler/zlib/archive/$(version).tar.gz", {
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_versions(version: <string>, hash: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -304,9 +325,12 @@ Used to set the version of each source package and the corresponding sha256 valu
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_versionfiles(file: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -340,9 +364,12 @@ package("libcurl")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_patches(version: <string>, url: <string>, hash: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -371,9 +398,12 @@ For example, the above code, when compiled for macosx, is marked with the corres
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_links(links: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -396,9 +426,12 @@ add_links("mbedtls", "mbedx509", "mbedcrypto")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_syslinks(syslinks: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -428,9 +461,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_linkorders(orders: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -455,12 +491,15 @@ package("libpng")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_linkgroups(groups: <string|array>, ..., {
     name = <string>,
     group = <boolean>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -487,9 +526,12 @@ package("libpng")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_frameworks(frameworks: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -510,9 +552,12 @@ See for example: [add_syslinks](#add_syslinks)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_linkdirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -531,9 +576,12 @@ The package's link library search directory can also be adjusted, but it is usua
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_includedirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -552,9 +600,12 @@ Add another header file search directory.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_bindirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -579,9 +630,12 @@ If you use this interface to configure `add_bindirs("bin")`, bin will be automat
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_defines(defines: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -600,6 +654,7 @@ Some specific definition options can be exported to the integrated package.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_configs(name: <string>, {
     description = <string>,
@@ -608,6 +663,8 @@ add_configs(name: <string>, {
     type = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -666,9 +723,12 @@ add_requires("pcre2", {configs = {bitwidth = 16}})
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_extsources(sources: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -719,9 +779,12 @@ In addition, we can also use this method to improve the search for packages inst
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -768,11 +831,14 @@ package("foo")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_components(components: <string|array>, ..., {
     deps = <array>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -816,9 +882,12 @@ A full example of the configuration and use of package components can be found a
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_base(package: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -863,9 +932,12 @@ We can install the tbb package through `add_requires("onetbb")` integration, but
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_load(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -897,9 +969,12 @@ To find out what methods are available to `package` look [here](/api/scripts/pac
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_fetch(platforms: <string|array>, ..., script: <function (package, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -934,9 +1009,12 @@ To find out what methods are available to `package` look [here](/api/scripts/pac
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_check(platforms: <string|array>, ..., script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -999,9 +1077,12 @@ package("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_install(platforms: <string|array>, ..., script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1189,9 +1270,12 @@ end)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_download(script: <function (package, opt)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1470,9 +1554,12 @@ end)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_test(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1543,9 +1630,12 @@ if the run fails, the test will not pass.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_component(component: <string>, script: <function (package, component)>)
 ```
+:::
+
 
 #### Parameter Description
 

Різницю між файлами не показано, бо вона завелика
+ 225 - 0
docs/api/description/project-target.md


+ 36 - 0
docs/api/description/xpack-component-interfaces.md

@@ -6,9 +6,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_title(title: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -29,9 +32,12 @@ xpack_component("LongPath")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -52,9 +58,12 @@ xpack_component("LongPath")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_default(default: <boolean>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -78,9 +87,12 @@ xpack_component("LongPath")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_load(script: <function (component)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -106,9 +118,12 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -139,9 +154,12 @@ It is exactly the same as xpack's before_installcmd. The only difference is that
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -168,9 +186,12 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -197,9 +218,12 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -222,9 +246,12 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -251,9 +278,12 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -280,6 +310,7 @@ xpack_component("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_sourcefiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -287,6 +318,8 @@ add_sourcefiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -306,6 +339,7 @@ This is similar to xpack's add_sourcefiles, but here only when the component is
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_installfiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -313,6 +347,8 @@ add_installfiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 

+ 120 - 0
docs/api/description/xpack-interfaces.md

@@ -17,9 +17,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_version(version: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -67,9 +70,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_homepage(homepage: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -90,9 +96,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_title(title: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -115,9 +124,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -140,9 +152,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_author(author: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -165,9 +180,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_maintainer(maintainer: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -192,9 +210,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_copyright(copyright: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -213,9 +234,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_license(license: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -235,9 +259,12 @@ set_license("Apache-2.0")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_licensefile(licensefile: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -258,9 +285,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_company(company: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -281,9 +311,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_inputkind(inputkind: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -327,9 +360,12 @@ If the above packaging configuration is an nsis package, the binary file will be
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_formats(formats: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -378,9 +414,12 @@ Currently supported formats are:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_basename(basename: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -412,9 +451,12 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_extension(extension: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -446,9 +488,12 @@ The package output file name returned by `package:outputfile()` will contain thi
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_targets(targets: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -481,9 +526,12 @@ And we can also use `on_installcmd`, `after_installcmd` and other custom packagi
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_components(components: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -530,9 +578,12 @@ Except for the NSIS package, although other packages do not have complete suppor
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_bindir(bindir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -559,9 +610,12 @@ Then the executable file will be installed under `installdir/mybin`. If it is an
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_libdir(libdir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -589,9 +643,12 @@ Then the static library files will be installed under `installdir/mylib`.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_includedir(includedir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -618,9 +675,12 @@ Then the header files will be installed under `installdir/myinc`.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_prefixdir(prefixdir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -651,9 +711,12 @@ installdir
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_specfile(specfile: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -720,9 +783,12 @@ In addition to built-in variables, we can also configure some custom template va
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_specvar(name: <string>, value: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -755,9 +821,12 @@ Before generating the package, xmake will replace `${FOO}` with hello, and then
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_iconfile(iconfile: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -778,6 +847,7 @@ xpack("xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_sourcefiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -785,6 +855,8 @@ add_sourcefiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -810,6 +882,7 @@ Its detailed usage is similar to `add_installfiles`, you can refer to its docume
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_installfiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -817,6 +890,8 @@ add_installfiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### Parameter Description
 
@@ -864,9 +939,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 add_buildrequires(requires: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -903,9 +981,12 @@ Since different installation packages have some differences in their dependent p
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_load(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -931,9 +1012,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_package(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -956,9 +1040,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_package(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -982,9 +1069,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_package(script: <function (package)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1007,9 +1097,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1049,9 +1142,12 @@ In addition, we can also use `add_buildrequires` to configure some build depende
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1075,9 +1171,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1101,9 +1200,12 @@ xpack("test")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1130,9 +1232,12 @@ It should be noted that the cp, mkdir and other commands added through `batchcmd
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1148,9 +1253,12 @@ This time, the built-in default installation script is completely rewritten, inc
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1177,9 +1285,12 @@ It should be noted that the cp, mkdir and other commands added through `batchcmd
 
 #### Function Prototype
 
+::: tip API
 ```lua
 before_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1195,9 +1306,12 @@ Similar to before_installcmd, please refer to before_installcmd description.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 on_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1213,9 +1327,12 @@ Similar to on_installcmd, please refer to on_installcmd description.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 after_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1231,9 +1348,12 @@ Similar to after_installcmd, please refer to after_installcmd description.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 set_nsis_displayicon(iconfile: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 18 - 0
docs/api/scripts/builtin-modules/coroutine.md

@@ -9,9 +9,12 @@ The coroutine module is a native module of lua. For use, see: [lua official manu
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.create(f: <function>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -35,9 +38,12 @@ end)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.resume(co: <thread>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -60,9 +66,12 @@ local success, result = coroutine.resume(co, "arg1", "arg2")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.yield(...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -84,9 +93,12 @@ coroutine.yield("value1", "value2")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.status(co: <thread>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -108,9 +120,12 @@ local status = coroutine.status(co)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.wrap(f: <function>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -135,9 +150,12 @@ local result = func()
 
 #### Function Prototype
 
+::: tip API
 ```lua
 coroutine.running()
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/cprint.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 cprint(...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/cprintf.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 cprintf(...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/format.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 format(formatstring: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 39 - 0
docs/api/scripts/builtin-modules/hash.md

@@ -9,9 +9,12 @@ The hash module provides hash value calculation and UUID generation functions. I
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.md5(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -43,9 +46,12 @@ print("MD5: " .. checksum)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.sha1(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -68,9 +74,12 @@ Calculates the SHA1 hash value of the specified string or file and returns a hex
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.sha256(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -104,9 +113,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.uuid(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -137,9 +149,12 @@ local config_id = hash.uuid("debug-x64-windows")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.xxhash32(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -157,9 +172,12 @@ Calculates hash value using the xxHash32 algorithm. xxHash is an extremely fast
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.xxhash64(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -182,9 +200,12 @@ local key = hash.xxhash64(table.concat(params, "|"))
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.xxhash128(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -202,9 +223,12 @@ Calculates hash value using the xxHash128 algorithm, providing longer hash value
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.strhash32(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -224,9 +248,12 @@ This interface uses xxhash32 internally, specifically designed for fast string h
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.strhash64(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -244,9 +271,12 @@ Generates a 64-bit hash value from a string, returns format like: `91e8ecf191e8e
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.strhash128(input: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -271,9 +301,12 @@ local cache_key = hash.strhash128(compiler .. flags .. source)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.rand32()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -293,9 +326,12 @@ This interface is prone to hash collisions and is not recommended for scenarios
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.rand64()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -311,9 +347,12 @@ Generates a 64-bit random hash value.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 hash.rand128()
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/import.md

@@ -4,9 +4,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 import(modulename: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/inherit.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 inherit(modulename: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 42 - 0
docs/api/scripts/builtin-modules/io.md

@@ -9,9 +9,12 @@ The io operation module extends lua's built-in io module to provide more easy-to
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.open(filename: <string>, mode: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -99,9 +102,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.load(filename: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -129,9 +135,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.save(filename: <string>, data: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -164,9 +173,12 @@ The result of the storage is:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.readfile(filename: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -208,9 +220,12 @@ xmake automatically detects and handles different newline formats (LF, CRLF) and
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.writefile(filename: <string>, data: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -233,9 +248,12 @@ io.writefile("xxx.txt", "all data")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.gsub(filename: <string>, pattern: <string>, replacement: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -260,9 +278,12 @@ io.gsub("xxx.txt", "%s+", "")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.tail(filename: <string>, lines: <number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -286,9 +307,12 @@ io.tail("xxx.txt", 10)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.cat(filename: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -310,9 +334,12 @@ io.cat("xxx.txt")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.print(filename: <string>, formatstring: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -336,9 +363,12 @@ io.print("xxx.txt", "hello %s!", "xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.printf(filename: <string>, formatstring: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -362,9 +392,12 @@ io.printf("xxx.txt", "hello %s!\n", "xmake")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.lines(filename: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -411,9 +444,12 @@ By default, newline characters are removed from each line. If you need to preser
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.stdfile(stdname: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -440,9 +476,12 @@ io.stderr
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.openlock(filename: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -467,9 +506,12 @@ lock:close()
 
 #### Function Prototype
 
+::: tip API
 ```lua
 io.replace(filename: <string>, pattern: <string>, replacement: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/ipairs.md

@@ -4,9 +4,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 ipairs(t: <table>, f: <function>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 9 - 0
docs/api/scripts/builtin-modules/linuxos.md

@@ -10,9 +10,12 @@ and its interface can be called directly in the script scope.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 linuxos.name()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -43,9 +46,12 @@ Some names currently supported are:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 linuxos.version()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -67,9 +73,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 linuxos.kernelver()
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/macos.md

@@ -8,9 +8,12 @@ The macOS system operation module is a built-in module, no need to use [import](
 
 #### Function Prototype
 
+::: tip API
 ```lua
 macos.version()
 ```
+:::
+
 
 #### Parameter Description
 

+ 189 - 0
docs/api/scripts/builtin-modules/os.md

@@ -14,9 +14,12 @@ Only some readonly interfaces (for example: `os.getenv`, `os.arch`) in the os mo
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.cp(source: <string>, destination: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -81,9 +84,12 @@ os.cp("$(scriptdir)/config.h", "$(builddir)/inc/config.h", {copy_if_different =
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.mv(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -110,9 +116,12 @@ os.mv("$(builddir)/libtest.a", "$(builddir)/libdemo.a")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.rm(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -135,9 +144,12 @@ os.rm("$(builddir)/lib/")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.trycp(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -161,9 +173,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.trymv(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -187,9 +202,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.tryrm(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -212,9 +230,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.cd(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -252,9 +273,12 @@ os.cd(oldir)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.rmdir(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -272,9 +296,12 @@ If it is not a directory, it cannot be deleted.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.mkdir(path: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -299,9 +326,12 @@ Supports recursive creation of multi-level directories, automatically creating p
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.touch(path: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -326,9 +356,12 @@ os.touch("file1.txt", "file2.txt", "file3.txt")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.isdir(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -352,9 +385,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.isfile(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -378,9 +414,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.exists(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -410,9 +449,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.islink(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -445,9 +487,12 @@ assert(os.islink("link.txt"))
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.dirs(pattern: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -472,9 +517,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.files(pattern: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -499,9 +547,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.filedirs(pattern: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -526,9 +577,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.exit(code: <number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -556,9 +610,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.isexec(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -588,9 +645,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.run(command: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -626,9 +686,12 @@ For more advanced process operations and control, see the [process](#process) mo
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.runv(program: <string>, args: <table>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -652,9 +715,12 @@ os.runv("echo", {"hello", "xmake!"})
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.exec(command: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -673,9 +739,12 @@ Similar to the [os.run](#os-run) interface, the only difference is that when thi
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.execv(program: <string>, args: <table>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -781,9 +850,12 @@ We can also get all the current environment variables through the `os.getenvs()`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.iorun(command: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -808,9 +880,12 @@ local outdata, errdata = os.iorun("echo hello xmake!")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.iorunv(program: <string>, args: <table>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -835,9 +910,12 @@ local outdata, errdata = os.iorunv("echo", {"hello", "xmake!"}, {envs = {PATH=".
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.tmpdir()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -863,9 +941,12 @@ print("$(tmpdir)/file.txt")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.tmpfile()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -902,9 +983,12 @@ Usage reference: [os.tmpdir](#os-tmpdir).
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.filesize(filepath: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -936,9 +1020,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.scriptdir()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -956,9 +1043,12 @@ Usage reference: [os.tmpdir](#os-tmpdir).
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.programdir()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -974,9 +1064,12 @@ Consistent with the result of [$(programdir)](/api/description/builtin-variables
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.programfile()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1003,9 +1096,12 @@ Consistent with the result of [$(projectdir)](/api/description/builtin-variables
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.arch()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1032,9 +1128,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.host()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1063,9 +1162,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.subhost()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1103,9 +1205,12 @@ Gets the architecture of the subsystem. If not running in a subsystem environmen
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.is_host(host: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1144,9 +1249,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.is_arch(arch: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1175,9 +1283,12 @@ Supports checking multiple architectures at once.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.is_subhost(subhost: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1206,9 +1317,12 @@ It's recommended to use the more concise built-in interface `is_subhost()` with
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.is_subarch(subarch: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1231,9 +1345,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.ln(source: <string>, target: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1255,9 +1372,12 @@ os.ln("xxx.txt", "xxx.txt.ln")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.readlink(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1285,9 +1405,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.raise(message: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1312,9 +1435,12 @@ Recommanded to use builtin function `raise` instead of `os.raise`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.raiselevel(level: <number>, message: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1336,9 +1462,12 @@ os.raiselevel(3,"an error occurred")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.features()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1354,9 +1483,12 @@ Gets a list of features supported by the current operating system. Returns a tab
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.getenvs()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1376,9 +1508,12 @@ print(envs["HOME"])
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.setenvs(envs: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1394,9 +1529,12 @@ os.setenvs(envs: <table>)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.addenvs(envs: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1420,9 +1558,12 @@ print(oldenvs["EXAMPLE"]) -- got a/path
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.joinenvs(envs1: <table>, envs2: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1447,9 +1588,12 @@ The result is: `{ CUSTOM = "a/path;some/path/" }`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.getenv(name: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1477,9 +1621,12 @@ local home = os.getenv("HOME") or "/tmp"
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.setenv(name: <string>, value: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1507,9 +1654,12 @@ os.setenv("PATH", "/new/path:" .. os.getenv("PATH"))
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.addenv(name: <string>, value: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1536,9 +1686,12 @@ print(os.getenv("PATH"))  -- New path will be appended to existing PATH
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.setenvp(name: <string>, value: <string>, separator: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1558,9 +1711,12 @@ Sets an environment variable using a specified separator. Similar to [os.setenv]
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.addenvp(name: <string>, value: <string>, separator: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1580,9 +1736,12 @@ Appends a value to an environment variable using a specified separator. Similar
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.workingdir()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1606,9 +1765,12 @@ print("Working directory:", os.workingdir())
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.isroot()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1632,9 +1794,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.fscase()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1659,9 +1824,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.term()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1680,9 +1848,12 @@ print(os.term())
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.shell()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1701,9 +1872,12 @@ print(os.shell())
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.cpuinfo(key: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1733,9 +1907,12 @@ print(os.cpuinfo("march")) -- got "Kaby Lake"
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.meminfo(key: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1761,9 +1938,12 @@ print(os.meminfo())
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.default_njob()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1784,9 +1964,12 @@ print("Default parallel jobs:", njob)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.argv(command: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1836,9 +2019,12 @@ os.argv('-DTEST="hello world"', {splitonly = true})  -- Returns: {'-DTEST="hello
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.args(args: <table>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -1893,9 +2079,12 @@ local cmdline2 = os.args(args)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 os.mclock()
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/pairs.md

@@ -4,9 +4,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 pairs(t: <table>, f: <function>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 54 - 0
docs/api/scripts/builtin-modules/path.md

@@ -9,9 +9,12 @@ The path operation module implements cross-platform path operations, which is a
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.new(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -34,9 +37,12 @@ The result is: `file.txt`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.join(paths: <string|array>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -63,9 +69,12 @@ If you find this cumbersome and not clear enough, you can use: [path.translate](
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.translate(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -91,9 +100,12 @@ The path strings of the above three different formats, after being standardized
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.basename(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -115,9 +127,12 @@ The result is: `file`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.filename(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -139,9 +154,12 @@ The result is: `file.txt`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.extension(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -163,9 +181,12 @@ The result is: `.txt`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.directory(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -187,9 +208,12 @@ The result is: `$(tmpdir)/dir`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.relative(path: <string>, rootdir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -221,9 +245,12 @@ The result is the same.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.absolute(path: <string>, rootdir: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -255,9 +282,12 @@ The result is the same.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.is_absolute(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -279,9 +309,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.split(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -302,9 +335,12 @@ The result is: `{ "tmp", "file.txt" }`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.sep()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -326,9 +362,12 @@ The result is: `/`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.islastsep(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -350,9 +389,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.splitenv(envpath: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -382,9 +424,12 @@ The result is an array of strings, each item is a path in the input string.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.joinenv(paths: <array>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -405,9 +450,12 @@ The result is: `/tmp/dir;/tmp/dir2` (on Windows)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.envsep()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -429,9 +477,12 @@ The result is: `;`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.cygwin_path(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -452,9 +503,12 @@ The result is: `/C/Windows`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 path.pattern(path: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/print.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 print(...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/printf.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 printf(...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/raise.md

@@ -5,9 +5,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 raise(message: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 9 - 0
docs/api/scripts/builtin-modules/signal.md

@@ -8,9 +8,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 signal.register(signo: <number>, handler: <function>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -65,9 +68,12 @@ For the background of this issue, please refer to: [#4889](https://github.com/xm
 
 #### Function Prototype
 
+::: tip API
 ```lua
 signal.ignore(signo: <number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -89,9 +95,12 @@ signal.ignore(signal.SIGINT)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 signal.reset(signo: <number>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 18 - 0
docs/api/scripts/builtin-modules/string.md

@@ -11,9 +11,12 @@ It has been extended in xmake to add some extension interfaces:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.startswith(str: <string>, prefix: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -37,9 +40,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.endswith(str: <string>, suffix: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -63,9 +69,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.split(str: <string>, separator: <string>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -120,9 +129,12 @@ limit split count
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.trim(str: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -144,9 +156,12 @@ The result is: "hello xmake!"
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.ltrim(str: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -168,9 +183,12 @@ The result is: "hello xmake!    "
 
 #### Function Prototype
 
+::: tip API
 ```lua
 string.rtrim(str: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 18 - 0
docs/api/scripts/builtin-modules/table.md

@@ -11,9 +11,12 @@ It has been extended in xmake to add some extension interfaces:
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.join(tables: <table>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -46,9 +49,12 @@ The result is: `{a = "a", b = "b", c = "c", d = "d"}`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.join2(target: <table>, tables: <table>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -75,9 +81,12 @@ The result is: `t = {0, 9, 1, 2, 3}`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.unique(tbl: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -101,9 +110,12 @@ The result is: `{1, 2, 3, 4, 5}`
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.slice(tbl: <table>, start: <number>, stop: <number>, step: <number>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -135,9 +147,12 @@ table.slice({1, 2, 3, 4, 5, 6, 7, 8, 9}, 4, 8, 2)
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.contains(tbl: <table>, values: <any>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -163,9 +178,12 @@ As long as the table contains any value from 1, 2, 3, it returns true
 
 #### Function Prototype
 
+::: tip API
 ```lua
 table.orderkeys(tbl: <table>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/builtin-modules/vformat.md

@@ -4,9 +4,12 @@
 
 #### Function Prototype
 
+::: tip API
 ```lua
 vformat(formatstring: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 

+ 12 - 0
docs/api/scripts/builtin-modules/winos.md

@@ -9,9 +9,12 @@ you can directly call its interface in the script scope.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 winos.version()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -55,9 +58,12 @@ win10 = "10.0"
 
 #### Function Prototype
 
+::: tip API
 ```lua
 winos.registry_keys(pattern: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -82,9 +88,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 winos.registry_values(pattern: <string>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -109,9 +118,12 @@ end
 
 #### Function Prototype
 
+::: tip API
 ```lua
 winos.registry_query(keypath: <string>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 12 - 0
docs/api/scripts/extension-modules/async/jobgraph.md

@@ -8,9 +8,12 @@ This module provides a job graph (DAG) for advanced asynchronous job scheduling
 
 #### Function Prototype
 
+::: tip API
 ```lua
 jobgraph.new()
 ```
+:::
+
 
 #### Parameter Description
 
@@ -31,9 +34,12 @@ local jobs = jobgraph.new()
 
 #### Function Prototype
 
+::: tip API
 ```lua
 jobgraph:add(name: <string>, jobfunc: <function>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -96,9 +102,12 @@ rule("foo")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 jobgraph:add_orders(jobname: <string>, ...)
 ```
+:::
+
 
 #### Parameter Description
 
@@ -122,9 +131,12 @@ jobs:add_orders("job/child", "job/root")
 
 #### Function Prototype
 
+::: tip API
 ```lua
 jobgraph:group(groupname: <string>, callback: <function>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 3 - 0
docs/api/scripts/extension-modules/async/runjobs.md

@@ -8,9 +8,12 @@ Run all jobs in the job graph concurrently.
 
 #### Function Prototype
 
+::: tip API
 ```lua
 runjobs(name: <string>, jobs: <jobgraph>, options: <table>)
 ```
+:::
+
 
 #### Parameter Description
 

+ 36 - 0
docs/zh/api/description/conditions.md

@@ -8,9 +8,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_os(os: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -42,9 +45,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_arch(arch: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -86,9 +92,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_plat(plat: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -137,9 +146,12 @@ $ xmake f -p other --sdk=...
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_host(host: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -177,9 +189,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_subhost(subhost: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -217,9 +232,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_subarch(subarch: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -241,9 +259,12 @@ is_subarch(subarch: <string>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_cross()
 ```
+:::
+
 
 #### 参数说明
 
@@ -261,9 +282,12 @@ is_cross()
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_mode(mode: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -299,9 +323,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_kind(kind: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -349,9 +376,12 @@ $ xmake
 
 #### 函数原型
 
+::: tip API
 ```lua
 is_config(name: <string>, values: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -418,9 +448,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 has_config(configs: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -473,9 +506,12 @@ $ xmake f --test1=false
 
 #### 函数原型
 
+::: tip API
 ```lua
 has_package(packages: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 66 - 0
docs/zh/api/description/configuration-option.md

@@ -33,9 +33,12 @@ option("test2")
 
 #### 函数原型
 
+::: tip API
 ```lua
 option(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -76,9 +79,12 @@ $ xmake
 
 #### 函数原型
 
+::: tip API
 ```lua
 option_end()
 ```
+:::
+
 
 #### 参数说明
 
@@ -96,9 +102,12 @@ option_end()
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -140,9 +149,12 @@ option("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_check(script: <function (option)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -164,9 +176,12 @@ option("zlib")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_check(script: <function (option)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -196,9 +211,12 @@ option("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_check(script: <function (option)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -225,9 +243,12 @@ option("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_values(values: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -256,9 +277,12 @@ option("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_default(value: <string|boolean|number>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -328,9 +352,12 @@ $ xmake
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_showmenu(showmenu: <boolean>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -366,9 +393,12 @@ Options:
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_category(category: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -455,9 +485,12 @@ option("test4")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_description(description: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -520,9 +553,12 @@ $ xmake f --mode=release
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_links(links: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -553,9 +589,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_linkdirs(linkdirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -574,9 +613,12 @@ add_linkdirs(linkdirs: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_rpathdirs(rpathdirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -595,9 +637,12 @@ add_rpathdirs(rpathdirs: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cincludes(includes: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -629,9 +674,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cxxincludes(includes: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -650,9 +698,12 @@ add_cxxincludes(includes: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_ctypes(types: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -684,9 +735,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cxxtypes(types: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -705,6 +759,7 @@ add_cxxtypes(types: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_csnippets(name: <string>, code: <string>, {
     tryrun = <boolean>,
@@ -712,6 +767,8 @@ add_csnippets(name: <string>, code: <string>, {
     number = <boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -734,6 +791,7 @@ add_csnippets(name: <string>, code: <string>, {
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cxxsnippets(name: <string>, code: <string>, {
     tryrun = <boolean>,
@@ -741,6 +799,8 @@ add_cxxsnippets(name: <string>, code: <string>, {
     number = <boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -803,9 +863,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cfuncs(funcs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -851,9 +914,12 @@ sigsetjmp{int a = 0; sigsetjmp((void*)a, a);}
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_cxxfuncs(funcs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 117 - 0
docs/zh/api/description/custom-rule.md

@@ -101,9 +101,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 rule(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -127,11 +130,14 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ..., {
     order = <boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -211,9 +217,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_imports(modules: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -232,9 +241,12 @@ add_imports(modules: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_extensions(extensions: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -272,9 +284,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_load(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -299,9 +314,12 @@ rule("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_link(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -325,9 +343,12 @@ rule("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_config(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -353,9 +374,12 @@ on_load -> after_load -> on_config -> before_build -> on_build -> after_build
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_build(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -379,9 +403,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_clean(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -406,9 +433,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_package(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -433,9 +463,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_install(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -459,9 +492,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -485,9 +521,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -512,9 +551,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -600,9 +642,12 @@ rule("lex")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -634,9 +679,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -664,9 +712,12 @@ rule("foo")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_config(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -692,9 +743,12 @@ rule("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_link(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -718,9 +772,12 @@ rule("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_build(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -744,9 +801,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_clean(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -770,9 +830,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_package(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -796,9 +859,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_install(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -822,9 +888,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -848,9 +917,12 @@ rule("markdown")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -869,9 +941,12 @@ before_build_file(script: <function (target, sourcefile, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -890,9 +965,12 @@ before_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -911,9 +989,12 @@ before_build_files(script: <function (target, sourcebatch, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -932,9 +1013,12 @@ before_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_config(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -960,9 +1044,12 @@ rule("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_link(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -980,9 +1067,12 @@ after_link(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_build(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1000,9 +1090,12 @@ after_build(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_clean(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1020,9 +1113,12 @@ after_clean(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_package(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1040,9 +1136,12 @@ after_package(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_install(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1060,9 +1159,12 @@ after_install(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_uninstall(script: <function (target)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1080,9 +1182,12 @@ after_uninstall(script: <function (target)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_build_file(script: <function (target, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1101,9 +1206,12 @@ after_build_file(script: <function (target, sourcefile, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1122,9 +1230,12 @@ after_buildcmd_file(script: <function (target, batchcmds, sourcefile, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_build_files(script: <function (target, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1143,9 +1254,12 @@ after_build_files(script: <function (target, sourcebatch, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1164,9 +1278,12 @@ after_buildcmd_files(script: <function (target, batchcmds, sourcebatch, opt)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 rule_end()
 ```
+:::
+
 
 #### 参数说明
 

+ 24 - 0
docs/zh/api/description/custom-toolchain.md

@@ -79,9 +79,12 @@ $ xmake show -l toolchains
 
 #### 函数原型
 
+::: tip API
 ```lua
 toolchain(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -202,9 +205,12 @@ toolchain("my_toolchain")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_kind(kind: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -230,9 +236,12 @@ set_kind(kind: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_toolset(tool: <string>, tools: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -269,9 +278,12 @@ toolchain("myclang")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_sdkdir(sdkdir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -296,9 +308,12 @@ toolchain("myclang")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_bindir(bindir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -323,9 +338,12 @@ toolchain("myclang")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_check(script: <function (toolchain)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -352,9 +370,12 @@ toolchain("myclang")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_load(script: <function (toolchain)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -389,9 +410,12 @@ toolchain("myclang")
 
 #### 函数原型
 
+::: tip API
 ```lua
 toolchain_end()
 ```
+:::
+
 
 #### 参数说明
 

+ 57 - 0
docs/zh/api/description/global-interfaces.md

@@ -8,11 +8,14 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 includes(paths: <string|array>, ..., {
     rootdir = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -185,9 +188,12 @@ target("test2")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_project(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -213,12 +219,15 @@ set_version("1.5.1")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_version(version: <string>, {
     build = <string>,
     soname = <string|boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -288,9 +297,12 @@ set_version("1.0.1") -> libfoo.so, libfoo.dylib
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_xmakever(version: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -317,9 +329,12 @@ set_xmakever("2.1.0")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_moduledirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -339,9 +354,12 @@ xmake内置的扩展模块都在`xmake/modules`目录下,可通过[import](/zh
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_plugindirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -367,9 +385,12 @@ add_plugindirs("$(projectdir)/plugins")
 
 #### 函数原型
 
+::: tip API
 ```lua
 get_config(name: <string>): <string|boolean|number>
 ```
+:::
+
 
 #### 参数说明
 
@@ -397,9 +418,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_config(name: <string>, value: <string|boolean|number>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -429,6 +453,7 @@ set_config("ld", "g++")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_requires(packages: <string|array>, ..., {
     optional = <boolean>,
@@ -441,6 +466,8 @@ add_requires(packages: <string|array>, ..., {
     ... = <any>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -696,6 +723,7 @@ add_requires("ffmpeg[shared,debug,codecs=[foo,bar,zoo]]")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_requireconfs(packages: <string|array>, ..., {
     configs = <table>,
@@ -705,6 +733,8 @@ add_requireconfs(packages: <string|array>, ..., {
     ... = <any>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -851,11 +881,14 @@ add_requireconfs("libwebp.*|cmake", {debug = true})
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_repositories(repos: <string|array>, ..., {
     rootdir = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -913,9 +946,12 @@ add_repositories("my-repo myrepo", {rootdir = os.scriptdir()})
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_defaultplat(platform: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -941,9 +977,12 @@ set_defaultplat("iphoneos")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_defaultarchs(archs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -977,9 +1016,12 @@ set_defaultarchs("iphoneos|arm64", "windows|x64")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_defaultmode(mode: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1003,9 +1045,12 @@ set_defaultmode("releasedbg")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_allowedplats(platforms: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1032,9 +1077,12 @@ set_allowedplats("windows", "mingw")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_allowedarchs(archs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1069,9 +1117,12 @@ set_allowedarchs("windows|x64", "iphoneos|arm64")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_allowedmodes(modes: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1098,9 +1149,12 @@ set_allowedmodes("release", "releasedbg")
 
 #### 函数原型
 
+::: tip API
 ```lua
 namespace(name: <string>, script: <function>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1412,9 +1466,12 @@ end)
 
 #### 函数原型
 
+::: tip API
 ```lua
 namespace_end()
 ```
+:::
+
 
 #### 参数说明
 

+ 90 - 0
docs/zh/api/description/package-dependencies.md

@@ -6,9 +6,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 package(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -62,9 +65,12 @@ package("libxml2")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_homepage(url: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -82,9 +88,12 @@ set_homepage(url: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -102,11 +111,14 @@ set_description(description: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_kind(kind: <string>, {
     headeronly = <boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -177,6 +189,7 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_urls(urls: <string|array>, ..., {
     excludes = <array>,
@@ -184,6 +197,8 @@ set_urls(urls: <string|array>, ..., {
     http_headers = <array>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -203,6 +218,7 @@ set_urls(urls: <string|array>, ..., {
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_urls(urls: <string|array>, ..., {
     alias = <string>,
@@ -211,6 +227,8 @@ add_urls(urls: <string|array>, ..., {
     http_headers = <array>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -277,9 +295,12 @@ add_urls("https://github.com/madler/zlib/archive/$(version).tar.gz", {
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_versions(version: <string>, hash: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -298,9 +319,12 @@ add_versions(version: <string>, hash: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_versionfiles(file: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -334,9 +358,12 @@ package("libcurl")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_patches(version: <string>, url: <string>, hash: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -365,9 +392,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_links(links: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -390,9 +420,12 @@ add_links("mbedtls", "mbedx509", "mbedcrypto")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_syslinks(syslinks: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -422,9 +455,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_linkorders(orders: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -449,12 +485,15 @@ package("libpng")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_linkgroups(groups: <string|array>, ..., {
     name = <string>,
     group = <boolean>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -481,9 +520,12 @@ package("libpng")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_frameworks(frameworks: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -502,9 +544,12 @@ add_frameworks(frameworks: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_linkdirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -523,9 +568,12 @@ add_linkdirs(dirs: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_includedirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -544,9 +592,12 @@ add_includedirs(dirs: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_bindirs(dirs: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -571,9 +622,12 @@ add_bindirs(dirs: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_defines(defines: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -592,6 +646,7 @@ add_defines(defines: <string|array>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_configs(name: <string>, {
     description = <string>,
@@ -600,6 +655,8 @@ add_configs(name: <string>, {
     type = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -658,9 +715,12 @@ add_requires("pcre2", {configs = {bitwidth = 16}})
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_extsources(sources: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -712,9 +772,12 @@ package("libusb")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_deps(deps: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -763,11 +826,14 @@ package("foo")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_components(components: <string|array>, ..., {
     deps = <array>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -813,9 +879,12 @@ target("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_base(package: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -860,9 +929,12 @@ package("onetbb")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_load(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -892,9 +964,12 @@ pcre包需要做一些针对bitwidth的判断,才能确定对外输出的链
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_fetch(platforms: <string|array>, ..., script: <function (package, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -927,9 +1002,12 @@ package("libusb")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_check(platforms: <string|array>, ..., script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -992,9 +1070,12 @@ package("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_install(platforms: <string|array>, ..., script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1182,9 +1263,12 @@ end)
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_test(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1255,9 +1339,12 @@ end)
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_download(script: <function (package, opt)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1345,9 +1432,12 @@ package("zlib")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_component(component: <string>, script: <function (package, component)>)
 ```
+:::
+
 
 #### 参数说明
 

Різницю між файлами не показано, бо вона завелика
+ 225 - 0
docs/zh/api/description/project-target.md


+ 36 - 0
docs/zh/api/description/xpack-component-interfaces.md

@@ -6,9 +6,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_title(title: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -29,9 +32,12 @@ xpack_component("LongPath")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -52,9 +58,12 @@ xpack_component("LongPath")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_default(default: <boolean>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -78,9 +87,12 @@ xpack_component("LongPath")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_load(script: <function (component)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -108,9 +120,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -139,9 +154,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -168,9 +186,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_installcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -197,9 +218,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -222,9 +246,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -251,9 +278,12 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_uninstallcmd(script: <function (component, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -280,6 +310,7 @@ xpack_component("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_sourcefiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -287,6 +318,8 @@ add_sourcefiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -306,6 +339,7 @@ add_sourcefiles(files: <string|array>, ..., {
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_installfiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -313,6 +347,8 @@ add_installfiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 

+ 120 - 0
docs/zh/api/description/xpack-interfaces.md

@@ -17,9 +17,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_version(version: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -67,9 +70,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_homepage(homepage: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -90,9 +96,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_title(title: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -115,9 +124,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_description(description: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -140,9 +152,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_author(author: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -165,9 +180,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_maintainer(maintainer: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -192,9 +210,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_copyright(copyright: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -215,9 +236,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_license(license: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -239,9 +263,12 @@ set_license("Apache-2.0")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_licensefile(licensefile: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -264,9 +291,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_company(company: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -289,9 +319,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_inputkind(inputkind: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -337,9 +370,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_formats(formats: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -390,9 +426,12 @@ $ xmake pack -f "nsis,zip"
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_basename(basename: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -426,9 +465,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_extension(extension: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -462,9 +504,12 @@ xpack("mypack")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_targets(targets: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -499,9 +544,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_components(components: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -550,9 +598,12 @@ xpack_component("LongPath")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_bindir(bindir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -581,9 +632,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_libdir(libdir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -613,9 +667,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_includedir(includedir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -644,9 +701,12 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_prefixdir(prefixdir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -679,9 +739,12 @@ installdir
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_specfile(specfile: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -750,9 +813,12 @@ VIAddVersionKey /LANG=0 OriginalFilename "${PACKAGE_FILENAME}"
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_specvar(name: <string>, value: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -787,9 +853,12 @@ VIAddVersionKey /LANG=0 ProductName      "${FOO}"
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_iconfile(iconfile: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -812,6 +881,7 @@ xpack("xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_sourcefiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -819,6 +889,8 @@ add_sourcefiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -846,6 +918,7 @@ add_sourcefiles(files: <string|array>, ..., {
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_installfiles(files: <string|array>, ..., {
     prefixdir = <string>,
@@ -853,6 +926,8 @@ add_installfiles(files: <string|array>, ..., {
     filename = <string>
 })
 ```
+:::
+
 
 #### 参数说明
 
@@ -902,9 +977,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 add_buildrequires(requires: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -945,9 +1023,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_load(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -976,9 +1057,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_package(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1003,9 +1087,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_package(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1033,9 +1120,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_package(script: <function (package)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1062,9 +1152,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1095,9 +1188,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1141,9 +1237,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1171,9 +1270,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_buildcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1201,9 +1303,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1223,9 +1328,12 @@ on_installcmd(script: <function (package, batchcmds)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_installcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1256,9 +1364,12 @@ xpack("test")
 
 #### 函数原型
 
+::: tip API
 ```lua
 before_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1278,9 +1389,12 @@ before_uninstallcmd(script: <function (package, batchcmds)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 on_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1300,9 +1414,12 @@ on_uninstallcmd(script: <function (package, batchcmds)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 after_uninstallcmd(script: <function (package, batchcmds)>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1322,9 +1439,12 @@ after_uninstallcmd(script: <function (package, batchcmds)>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 set_nsis_displayicon(iconfile: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 18 - 0
docs/zh/api/scripts/builtin-modules/coroutine.md

@@ -9,9 +9,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.create(f: <function>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -35,9 +38,12 @@ end)
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.resume(co: <thread>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -60,9 +66,12 @@ local success, result = coroutine.resume(co, "arg1", "arg2")
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.yield(...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -84,9 +93,12 @@ coroutine.yield("value1", "value2")
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.status(co: <thread>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -108,9 +120,12 @@ local status = coroutine.status(co)
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.wrap(f: <function>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -135,9 +150,12 @@ local result = func()
 
 #### 函数原型
 
+::: tip API
 ```lua
 coroutine.running()
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/cprint.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 cprint(...)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/cprintf.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 cprintf(...)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/format.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 format(formatstring: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 39 - 0
docs/zh/api/scripts/builtin-modules/hash.md

@@ -9,9 +9,12 @@ hash 模块提供了哈希值计算和 UUID 生成功能,这是 xmake 的一
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.md5(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -38,9 +41,12 @@ print("MD5: " .. checksum)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.sha1(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -58,9 +64,12 @@ hash.sha1(input: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.sha256(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -89,9 +98,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.uuid(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -118,9 +130,12 @@ local config_id = hash.uuid("debug-x64-windows")
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.xxhash32(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -138,9 +153,12 @@ hash.xxhash32(input: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.xxhash64(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -163,9 +181,12 @@ local key = hash.xxhash64(table.concat(params, "|"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.xxhash128(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -183,9 +204,12 @@ hash.xxhash128(input: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.strhash32(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -205,9 +229,12 @@ hash.strhash32(input: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.strhash64(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -225,9 +252,12 @@ hash.strhash64(input: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.strhash128(input: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -252,9 +282,12 @@ local cache_key = hash.strhash128(compiler .. flags .. source)
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.rand32()
 ```
+:::
+
 
 #### 参数说明
 
@@ -274,9 +307,12 @@ hash.rand32()
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.rand64()
 ```
+:::
+
 
 #### 参数说明
 
@@ -292,9 +328,12 @@ hash.rand64()
 
 #### 函数原型
 
+::: tip API
 ```lua
 hash.rand128()
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/import.md

@@ -4,9 +4,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 import(modulename: <string>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/inherit.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 inherit(modulename: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 42 - 0
docs/zh/api/scripts/builtin-modules/io.md

@@ -9,9 +9,12 @@ io 操作模块,扩展了 lua 内置的 io 模块,提供更多易用的接
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.open(filename: <string>, mode: <string>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -99,9 +102,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.load(filename: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -129,9 +135,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.save(filename: <string>, data: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -164,9 +173,12 @@ io.save("xxx.txt", {a = "a", b = "b", c = "c"})
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.readfile(filename: <string>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -208,9 +220,12 @@ xmake 会自动检测并处理不同的换行符格式(LF、CRLF),并自
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.writefile(filename: <string>, content: <string>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -234,9 +249,12 @@ io.writefile("xxx.txt", "all data")
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.gsub(filepath: <string>, pattern: <string>, replace: <string|function>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -262,9 +280,12 @@ io.gsub("xxx.txt", "%s+", "")
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.tail(filepath: <string>, lines: <number>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -288,9 +309,12 @@ io.tail("xxx.txt", 10)
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.cat(filepath: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -312,9 +336,12 @@ io.cat("xxx.txt")
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.print(content: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -336,9 +363,12 @@ io.print("xxx.txt", "hello %s!", "xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.printf(format: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -361,9 +391,12 @@ io.printf("xxx.txt", "hello %s!\n", "xmake")
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.lines(filepath: <string>, mode: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -410,9 +443,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.stdfile()
 ```
+:::
+
 
 #### 参数说明
 
@@ -437,9 +473,12 @@ io.stderr
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.openlock(filepath: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -464,9 +503,12 @@ lock:close()
 
 #### 函数原型
 
+::: tip API
 ```lua
 io.replace(filepath: <string>, pattern: <string>, replace: <string|function>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/ipairs.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 ipairs(t: <table>, f: <function>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 9 - 0
docs/zh/api/scripts/builtin-modules/linuxos.md

@@ -9,9 +9,12 @@ Linux 系统操作模块,属于内置模块,无需使用[import](/zh/api/scr
 
 #### 函数原型
 
+::: tip API
 ```lua
 linuxos.name()
 ```
+:::
+
 
 #### 参数说明
 
@@ -42,9 +45,12 @@ xmake l linuxos.name
 
 #### 函数原型
 
+::: tip API
 ```lua
 linuxos.version()
 ```
+:::
+
 
 #### 参数说明
 
@@ -66,9 +72,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 linuxos.kernelver()
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/macos.md

@@ -9,9 +9,12 @@ macOS 系统操作模块,属于内置模块,无需使用[import](/zh/api/scr
 
 #### 函数原型
 
+::: tip API
 ```lua
 macos.version()
 ```
+:::
+
 
 #### 参数说明
 

+ 344 - 5
docs/zh/api/scripts/builtin-modules/os.md

@@ -12,6 +12,24 @@ os 模块里面只有部分readonly接口(例如:`os.getenv`, `os.arch`)
 
 - 复制文件或目录
 
+#### 函数原型
+
+::: tip API
+```lua
+os.cp(source: <string>, destination: <string>, options: <table>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| source | 源路径或模式 |
+| destination | 目标路径 |
+| options | 选项表(可选) |
+
+#### 用法说明
+
 行为和shell中的`cp`命令类似,支持路径通配符匹配(使用的是lua模式匹配),支持多文件复制,以及内置变量支持。
 
 例如:
@@ -64,9 +82,12 @@ os.cp("$(scriptdir)/config.h", "$(builddir)/inc/config.h", {copy_if_different =
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.mv(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -93,9 +114,12 @@ os.mv("$(builddir)/libtest.a", "$(builddir)/libdemo.a")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.rm(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -118,9 +142,12 @@ os.rm("$(builddir)/lib/")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.trycp(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -144,9 +171,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.trymv(source: <string>, destination: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -170,9 +200,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.tryrm(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -195,9 +228,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.cd(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -235,9 +271,12 @@ os.cd(oldir)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.rmdir(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -255,9 +294,12 @@ os.rmdir(path: <string>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.mkdir(path: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -282,9 +324,12 @@ os.mkdir("$(tmpdir)/test", "$(builddir)/inc")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.touch(path: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -309,9 +354,12 @@ os.touch("file1.txt", "file2.txt", "file3.txt")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.isdir(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -335,9 +383,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.isfile(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -361,9 +412,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.exists(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -393,9 +447,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.islink(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -428,9 +485,12 @@ assert(os.islink("link.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.dirs(pattern: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -453,6 +513,22 @@ end
 
 - 遍历获取指定目录下的所有文件
 
+#### 函数原型
+
+::: tip API
+```lua
+os.files(pattern: <string>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| pattern | 文件模式 |
+
+#### 用法说明
+
 支持[add_files](#targetadd_files)中的模式匹配,支持递归和非递归模式遍历,返回的结果是一个table数组,如果获取不到,返回空数组,例如:
 
 ```lua
@@ -466,6 +542,22 @@ end
 
 - 遍历获取指定目录下的所有文件和目录
 
+#### 函数原型
+
+::: tip API
+```lua
+os.filedirs(pattern: <string>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| pattern | 文件模式 |
+
+#### 用法说明
+
 支持[add_files](#targetadd_files)中的模式匹配,支持递归和非递归模式遍历,返回的结果是一个table数组,如果获取不到,返回空数组,例如:
 
 ```lua
@@ -479,9 +571,21 @@ end
 
 - 退出程序
 
+#### 函数原型
+
+::: tip API
 ```lua
-os.exit(code)
+os.exit(code: <number>)
 ```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| code | 退出码(可选) |
+
+#### 用法说明
 
 退出当前程序,并返回指定的退出码。如果不指定退出码,默认为 0(成功)。
 
@@ -501,9 +605,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.isexec(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -533,9 +640,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.run(command: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -569,9 +679,12 @@ os.run("ls -l $(builddir)")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.runv(program: <string>, args: <table>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -601,9 +714,12 @@ os.runv("echo", {"hello", "xmake!"}, {envs = {PATH = "xxx;xx", CFLAGS = "xx"}})
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.exec(command: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -622,9 +738,12 @@ os.exec(command: <string>, ...)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.execv(program: <string>, args: <table>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -728,6 +847,23 @@ rpipe_err:close()
 
 - 安静运行原生shell命令并获取输出内容
 
+#### 函数原型
+
+::: tip API
+```lua
+os.iorun(command: <string>, options: <table>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| command | 命令字符串 |
+| options | 选项表(可选) |
+
+#### 用法说明
+
 与[os.run](#os-run)接口类似,唯一的不同是,此接口执行shell程序后,会获取shell程序的执行结果,相当于重定向输出。
 
 可同时获取`stdout`, `stderr`中的内容,例如:
@@ -740,6 +876,24 @@ local outdata, errdata = os.iorun("echo hello xmake!")
 
 - 安静运行原生shell命令并获取输出内容,带参数列表
 
+#### 函数原型
+
+::: tip API
+```lua
+os.iorunv(program: <string>, args: <table>, options: <table>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| program | 程序名称 |
+| args | 参数列表 |
+| options | 选项表(可选) |
+
+#### 用法说明
+
 跟[os.iorun](#os-iorun)类似,只是传递参数的方式是通过参数列表传递,而不是字符串命令,例如:
 
 ```lua
@@ -758,9 +912,12 @@ local outdata, errdata = os.iorunv("echo", {"hello", "xmake!"}, {envs = {PATH =
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.getenv(name: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -788,9 +945,12 @@ local home = os.getenv("HOME") or "/tmp"
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.setenv(name: <string>, value: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -818,9 +978,12 @@ os.setenv("PATH", "/new/path:" .. os.getenv("PATH"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.tmpdir()
 ```
+:::
+
 
 #### 参数说明
 
@@ -844,9 +1007,19 @@ print("$(tmpdir)/file.txt")
 
 - 获取临时文件路径
 
+#### 函数原型
+
+::: tip API
 ```lua
-local tmpfile = os.tmpfile()
+os.tmpfile()
 ```
+:::
+
+#### 参数说明
+
+此函数不需要参数。
+
+#### 用法说明
 
 生成一个唯一的临时文件路径,返回的仅是路径字符串,文件本身不会自动创建,需要自己创建。
 
@@ -869,9 +1042,12 @@ os.rm(tmpfile)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.curdir()
 ```
+:::
+
 
 #### 参数说明
 
@@ -889,9 +1065,12 @@ os.curdir()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.filesize(filepath: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -923,9 +1102,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.scriptdir()
 ```
+:::
+
 
 #### 参数说明
 
@@ -943,9 +1125,12 @@ os.scriptdir()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.programdir()
 ```
+:::
+
 
 #### 参数说明
 
@@ -961,9 +1146,12 @@ os.programdir()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.programfile()
 ```
+:::
+
 
 #### 参数说明
 
@@ -984,9 +1172,12 @@ print("xmake 路径:", os.programfile())
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.projectdir()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1002,9 +1193,12 @@ os.projectdir()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.arch()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1031,9 +1225,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.host()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1062,9 +1259,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.subhost()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1092,9 +1292,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.subarch()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1110,9 +1313,12 @@ os.subarch()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.is_host(host: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1150,9 +1356,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.is_arch(arch: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1181,9 +1390,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.is_subhost(subhost: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1212,9 +1424,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.is_subarch(subarch: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1237,9 +1452,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.ln(source: <string>, target: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1261,9 +1479,12 @@ os.ln("xxx.txt", "xxx.txt.ln")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.readlink(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1293,6 +1514,22 @@ end
 
 - 抛出一个异常并且中止当前脚本运行
 
+#### 函数原型
+
+::: tip API
+```lua
+os.raise(message: <string>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| message | 错误信息字符串 |
+
+#### 用法说明
+
 ```lua
 -- 抛出一个带 "an error occurred" 信息的异常
 os.raise("an error occurred")
@@ -1308,9 +1545,12 @@ os.raise("an error occurred")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.raiselevel(level: <number>, message: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1332,9 +1572,12 @@ os.raiselevel(3, "an error occurred")
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.features()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1350,9 +1593,12 @@ os.features()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.getenvs()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1372,9 +1618,12 @@ print(envs["HOME"])
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.setenvs(envs: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1390,9 +1639,12 @@ os.setenvs(envs: <table>)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.addenvs(envs: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1416,9 +1668,12 @@ print(oldenvs["EXAMPLE"]) -- got a/path
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.joinenvs(envs1: <table>, envs2: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1441,9 +1696,12 @@ print(os.joinenvs(envs0, envs1)) -- result is : { CUSTION = "a/path;some/path/"
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.addenv(name: <string>, value: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1468,9 +1726,23 @@ print(os.getenv("PATH"))  -- 新路径会被追加到现有 PATH 中
 
 - 使用给定分隔符设置环境变量
 
+#### 函数原型
+
+::: tip API
 ```lua
-os.setenvp("VAR", "value", "separator")
+os.setenvp(name: <string>, value: <string>, separator: <string>)
 ```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| name | 环境变量名 |
+| value | 环境变量值 |
+| separator | 分隔符字符串 |
+
+#### 用法说明
 
 设置环境变量,使用指定的分隔符。与 [os.setenv](#os-setenv) 类似,但可以自定义分隔符。
 
@@ -1478,9 +1750,23 @@ os.setenvp("VAR", "value", "separator")
 
 - 使用给定分隔符向环境变量添加值
 
+#### 函数原型
+
+::: tip API
 ```lua
-os.addenvp("VAR", "value", "separator")
+os.addenvp(name: <string>, value: <string>, separator: <string>)
 ```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| name | 环境变量名 |
+| value | 要添加的值 |
+| separator | 分隔符字符串 |
+
+#### 用法说明
 
 向环境变量追加值,使用指定的分隔符。与 [os.addenv](#os-addenv) 类似,但可以自定义分隔符。
 
@@ -1488,9 +1774,19 @@ os.addenvp("VAR", "value", "separator")
 
 - 获取工作目录
 
+#### 函数原型
+
+::: tip API
 ```lua
-local workdir = os.workingdir()
+os.workingdir()
 ```
+:::
+
+#### 参数说明
+
+此函数不需要参数。
+
+#### 用法说明
 
 获取当前工作目录的绝对路径。与 `os.curdir()` 类似,但返回的是工作目录而不是当前脚本执行目录。
 
@@ -1504,9 +1800,12 @@ print("工作目录:", os.workingdir())
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.isroot()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1530,9 +1829,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.fscase()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1557,9 +1859,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.term()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1573,9 +1878,12 @@ os.term()
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.shell()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1589,6 +1897,22 @@ os.shell()
 
 - 获取当前CPU信息
 
+#### 函数原型
+
+::: tip API
+```lua
+os.cpuinfo(key: <string>)
+```
+:::
+
+#### 参数说明
+
+| 参数 | 描述 |
+|------|------|
+| key | CPU信息键名(可选) |
+
+#### 用法说明
+
 ```lua
 print(os.cpuinfo())
 -- probably got {
@@ -1609,9 +1933,12 @@ print(os.cpuinfo("march")) -- probably got "Alder Lake"
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.meminfo(key: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1638,9 +1965,12 @@ print(os.meminfo("pagesize")) -- probably got 4096
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.default_njob()
 ```
+:::
+
 
 #### 参数说明
 
@@ -1661,9 +1991,12 @@ print("默认并行任务数:", njob)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.argv(command: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1712,9 +2045,12 @@ os.argv('-DTEST="hello world"', {splitonly = true})  -- 返回: {'-DTEST="hello
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.args(args: <table>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -1769,9 +2105,12 @@ local cmdline2 = os.args(args)
 
 #### 函数原型
 
+::: tip API
 ```lua
 os.mclock()
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/pairs.md

@@ -4,9 +4,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 pairs(t: <table>, f: <function>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 30 - 0
docs/zh/api/scripts/builtin-modules/path.md

@@ -9,9 +9,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.join(paths: <string|array>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -38,9 +41,12 @@ print(path.join("$(tmpdir)", "dir1", "dir2", "file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.translate(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -66,9 +72,12 @@ print(path.translate("$(tmpdir)\\dir/dir2//file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.basename(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -90,9 +99,12 @@ print(path.basename("$(tmpdir)/dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.filename(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -114,9 +126,12 @@ print(path.filename("$(tmpdir)/dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.extension(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -138,9 +153,12 @@ print(path.extension("$(tmpdir)/dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.directory(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -162,9 +180,12 @@ print(path.directory("$(tmpdir)/dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.relative(path: <string>, rootdir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -196,9 +217,12 @@ print(path.relative("$(tmpdir)/dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.absolute(path: <string>, rootdir: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -230,9 +254,12 @@ print(path.absolute("dir/file.txt"))
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.is_absolute(path: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -254,9 +281,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 path.splitenv(envpath: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/print.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 print(...)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/printf.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 printf(...)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/raise.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 raise(message: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 9 - 0
docs/zh/api/scripts/builtin-modules/signal.md

@@ -8,9 +8,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 signal.register(signo: <number>, handler: <function>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -65,9 +68,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 signal.ignore(signo: <number>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -89,9 +95,12 @@ signal.ignore(signal.SIGINT)
 
 #### 函数原型
 
+::: tip API
 ```lua
 signal.reset(signo: <number>)
 ```
+:::
+
 
 #### 参数说明
 

+ 18 - 0
docs/zh/api/scripts/builtin-modules/string.md

@@ -11,9 +11,12 @@ Xmake 中对其进行了扩展,增加了一些扩展接口:
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.startswith(str: <string>, prefix: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -37,9 +40,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.endswith(str: <string>, suffix: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -63,9 +69,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.split(str: <string>, separator: <string>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -122,9 +131,12 @@ v2.2.7版本对这个接口做了改进,以下是对2.2.7之后版本的使用
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.trim(str: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -146,9 +158,12 @@ string.trim("    hello xmake!    ")
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.ltrim(str: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -170,9 +185,12 @@ string.ltrim("    hello xmake!    ")
 
 #### 函数原型
 
+::: tip API
 ```lua
 string.rtrim(str: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 18 - 0
docs/zh/api/scripts/builtin-modules/table.md

@@ -11,9 +11,12 @@ Xmake 中对其进行了扩展,增加了一些扩展接口:
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.join(tables: <table>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -46,9 +49,12 @@ local newtable = table.join({a = "a", b = "b"}, {c = "c"}, {d = "d"})
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.join2(target: <table>, tables: <table>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -75,9 +81,12 @@ table.join2(t, {1, 2, 3})
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.unique(tbl: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -101,9 +110,12 @@ local newtable = table.unique({1, 1, 2, 3, 4, 4, 5})
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.slice(tbl: <table>, start: <number>, stop: <number>, step: <number>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -135,9 +147,12 @@ table.slice({1, 2, 3, 4, 5, 6, 7, 8, 9}, 4, 8, 2)
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.contains(tbl: <table>, values: <any>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -164,9 +179,12 @@ then
 
 #### 函数原型
 
+::: tip API
 ```lua
 table.orderkeys(tbl: <table>)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/builtin-modules/vformat.md

@@ -5,9 +5,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 vformat(formatstring: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 

+ 12 - 0
docs/zh/api/scripts/builtin-modules/winos.md

@@ -9,9 +9,12 @@ Windows 系统操作模块,属于内置模块,无需使用[import](/zh/api/s
 
 #### 函数原型
 
+::: tip API
 ```lua
 winos.version()
 ```
+:::
+
 
 #### 参数说明
 
@@ -56,9 +59,12 @@ win10    = "10.0"
 
 #### 函数原型
 
+::: tip API
 ```lua
 winos.registry_keys(pattern: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -83,9 +89,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 winos.registry_values(pattern: <string>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -110,9 +119,12 @@ end
 
 #### 函数原型
 
+::: tip API
 ```lua
 winos.registry_query(keypath: <string>)
 ```
+:::
+
 
 #### 参数说明
 

+ 12 - 0
docs/zh/api/scripts/extension-modules/async/jobgraph.md

@@ -8,9 +8,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 jobgraph.new()
 ```
+:::
+
 
 #### 参数说明
 
@@ -31,9 +34,12 @@ local jobs = jobgraph.new()
 
 #### 函数原型
 
+::: tip API
 ```lua
 jobgraph:add(name: <string>, jobfunc: <function>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 
@@ -96,9 +102,12 @@ rule("foo")
 
 #### 函数原型
 
+::: tip API
 ```lua
 jobgraph:add_orders(jobname: <string>, ...)
 ```
+:::
+
 
 #### 参数说明
 
@@ -122,9 +131,12 @@ jobs:add_orders("job/child", "job/root")
 
 #### 函数原型
 
+::: tip API
 ```lua
 jobgraph:group(groupname: <string>, callback: <function>)
 ```
+:::
+
 
 #### 参数说明
 

+ 3 - 0
docs/zh/api/scripts/extension-modules/async/runjobs.md

@@ -8,9 +8,12 @@
 
 #### 函数原型
 
+::: tip API
 ```lua
 runjobs(name: <string>, jobs: <jobgraph>, options: <table>)
 ```
+:::
+
 
 #### 参数说明
 

Деякі файли не було показано, через те що забагато файлів було змінено