From 2414ab231ddf94fa431d05e725f8fe0b818d9cf4 Mon Sep 17 00:00:00 2001 From: peefy Date: Mon, 22 Apr 2024 19:19:10 +0800 Subject: [PATCH] docs: add nodejs API documents Signed-off-by: peefy --- blog/2024-04-17-newsletter/index.md | 4 ++-- docs/reference/xlang-api/nodejs-api.md | 24 +++++++++++++++++++ .../2024-04-17-newsletter/index.md | 4 ++-- .../current/reference/xlang-api/nodejs-api.md | 24 +++++++++++++++++++ .../reference/xlang-api/nodejs-api.md | 24 +++++++++++++++++++ .../reference/xlang-api/nodejs-api.md | 24 +++++++++++++++++++ 6 files changed, 100 insertions(+), 4 deletions(-) create mode 100644 docs/reference/xlang-api/nodejs-api.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/nodejs-api.md create mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/xlang-api/nodejs-api.md create mode 100644 versioned_docs/version-0.8/reference/xlang-api/nodejs-api.md diff --git a/blog/2024-04-17-newsletter/index.md b/blog/2024-04-17-newsletter/index.md index 6fc4423b1..b635301d2 100644 --- a/blog/2024-04-17-newsletter/index.md +++ b/blog/2024-04-17-newsletter/index.md @@ -83,8 +83,8 @@ app: AppConfig { import { execProgram, ExecProgramArgs } from "kcl-lib"; function main() { - const result = execProgram(ExecProgramArgs(["__test__/test_data/schema.k"])); - console.log(result.yamlResult); // 'app:\n replicas: 2' + const result = execProgram(new ExecProgramArgs(["__test__/test_data/schema.k"])); + console.log(result.yamlResult); // 'app:\n replicas: 2' } main(); diff --git a/docs/reference/xlang-api/nodejs-api.md b/docs/reference/xlang-api/nodejs-api.md new file mode 100644 index 000000000..a16f58b14 --- /dev/null +++ b/docs/reference/xlang-api/nodejs-api.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 6 +--- + +# Node.js API + +## Installation + +```shell +npm install kcl-lib +``` + +## Quick Start + +```typescript +import { execProgram, ExecProgramArgs } from "kcl-lib"; + +function main() { + const result = execProgram(new ExecProgramArgs(["path/to/kcl.k"])); + console.log(result.yamlResult); +} + +main(); +``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/2024-04-17-newsletter/index.md b/i18n/zh-CN/docusaurus-plugin-content-blog/2024-04-17-newsletter/index.md index c83a98435..eaefbddd3 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-blog/2024-04-17-newsletter/index.md +++ b/i18n/zh-CN/docusaurus-plugin-content-blog/2024-04-17-newsletter/index.md @@ -83,8 +83,8 @@ app: AppConfig { import { execProgram, ExecProgramArgs } from "kcl-lib"; function main() { - const result = execProgram(ExecProgramArgs(["__test__/test_data/schema.k"])); - console.log(result.yamlResult); // 'app:\n replicas: 2' + const result = execProgram(new ExecProgramArgs(["__test__/test_data/schema.k"])); + console.log(result.yamlResult); // 'app:\n replicas: 2' } main(); diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/nodejs-api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/nodejs-api.md new file mode 100644 index 000000000..cf9ccbc42 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/nodejs-api.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 6 +--- + +# Node.js API + +## 添加依赖 + +```shell +npm install kcl-lib +``` + +## 快速开始 + +```typescript +import { execProgram, ExecProgramArgs } from "kcl-lib"; + +function main() { + const result = execProgram(new ExecProgramArgs(["path/to/kcl.k"])); + console.log(result.yamlResult); +} + +main(); +``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/xlang-api/nodejs-api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/xlang-api/nodejs-api.md new file mode 100644 index 000000000..cf9ccbc42 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/xlang-api/nodejs-api.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 6 +--- + +# Node.js API + +## 添加依赖 + +```shell +npm install kcl-lib +``` + +## 快速开始 + +```typescript +import { execProgram, ExecProgramArgs } from "kcl-lib"; + +function main() { + const result = execProgram(new ExecProgramArgs(["path/to/kcl.k"])); + console.log(result.yamlResult); +} + +main(); +``` diff --git a/versioned_docs/version-0.8/reference/xlang-api/nodejs-api.md b/versioned_docs/version-0.8/reference/xlang-api/nodejs-api.md new file mode 100644 index 000000000..a16f58b14 --- /dev/null +++ b/versioned_docs/version-0.8/reference/xlang-api/nodejs-api.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 6 +--- + +# Node.js API + +## Installation + +```shell +npm install kcl-lib +``` + +## Quick Start + +```typescript +import { execProgram, ExecProgramArgs } from "kcl-lib"; + +function main() { + const result = execProgram(new ExecProgramArgs(["path/to/kcl.k"])); + console.log(result.yamlResult); +} + +main(); +```