Merge pull request #288 from zong-zhe/file-builtin-doc

feat: add docs for filesystem builtin functions

Author: Peefy

docs/reference/model/file.md

@@ -0,0 +1,31 @@
+---
+title: "file"
+linkTitle: "file"
+type: "docs"
+description: file system functions
+weight: 100
+---
+
+## read
+
+`read(filepath: string) -> str`
+
+Read the contents of the file `filepath` and return a string instance.
+
+## glob
+
+`glob(pattern: str) -> str`
+
+Return a list containing all file names that match `pattern`.
+
+## modpath
+
+`modpath() -> str`
+
+Return the root path of the current KCL module (kcl.mod file path or single *.k file path).
+
+## workdir
+
+`workdir() -> str`
+
+Return the path of the current working directory.

docs/reference/model/overview.md

@@ -51,4 +51,7 @@ For relatively complex general logic, it is provided through the system modules.
   <DocsCard header="yaml" href="yaml">
     <p>Provides YAML related encoding/decoding functions.</p>
   </DocsCard>
+   <DocsCard header="file" href="file">
+    <p>Provides filesystem functions.</p>
+  </DocsCard>
 </DocsCards>

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/model/file.md

@@ -0,0 +1,32 @@
+---
+title: "file"
+linkTitle: "file"
+type: "docs"
+description: 文件系统操作
+weight: 100
+---
+
+## read
+
+
+`read(filepath: string) -> str`
+
+读取文件 `filepath` 中的内容，并返回一个字符串实例。
+
+## glob
+
+`glob(pattern: str) -> str`
+
+返回一个包含所有匹配 `pattern` 的文件名的列表。
+
+## modpath
+
+`modpath() -> str`
+
+返回当前模块的根路径（kcl.mod 文件路径或单个 *.k 文件路径）。
+
+## workdir
+
+`workdir() -> str`
+
+返回当前工作目录的路径。

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/model/overview.md

@@ -51,4 +51,7 @@ KCL 通过内置模块、系统库模块和插件模块提供工程化的扩展
   <DocsCard header="yaml" href="yaml">
     <p>提供了与 YAML 相关的编码/解码函数。</p>
   </DocsCard>
+  <DocsCard header="file" href="yaml">
+    <p>提供了与文件系统相关的函数。</p>
+  </DocsCard>
 </DocsCards>