diff --git a/website/docs/en/_nav.json b/website/docs/en/_nav.json index dc26b30..e5db6bc 100644 --- a/website/docs/en/_nav.json +++ b/website/docs/en/_nav.json @@ -1,19 +1,9 @@ [ { "text": "Guide", - "link": "/guide/introduction", + "link": "/guide/quick-start", "activeMatch": "/guide/" }, - { - "text": "Commands", - "link": "/commands/", - "activeMatch": "/commands/" - }, - { - "text": "Configuration", - "link": "/config/", - "activeMatch": "/config/" - }, { "text": "Changelog", "link": "https://github.com/rstackjs/rstack-cli/releases" diff --git a/website/docs/en/commands/_meta.json b/website/docs/en/commands/_meta.json deleted file mode 100644 index 788d5e0..0000000 --- a/website/docs/en/commands/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "type": "file", - "name": "index", - "label": "Command overview" - } -] diff --git a/website/docs/en/commands/index.mdx b/website/docs/en/commands/index.mdx deleted file mode 100644 index 727934a..0000000 --- a/website/docs/en/commands/index.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Commands - -TODO. diff --git a/website/docs/en/config/_meta.json b/website/docs/en/config/_meta.json deleted file mode 100644 index 0b7b11f..0000000 --- a/website/docs/en/config/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "type": "file", - "name": "index", - "label": "Configuration overview" - } -] diff --git a/website/docs/en/config/index.mdx b/website/docs/en/config/index.mdx deleted file mode 100644 index 0da5e80..0000000 --- a/website/docs/en/config/index.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Configuration - -TODO. diff --git a/website/docs/en/guide/_meta.json b/website/docs/en/guide/_meta.json index 8fbb258..89dfe2e 100644 --- a/website/docs/en/guide/_meta.json +++ b/website/docs/en/guide/_meta.json @@ -1,12 +1,21 @@ [ { - "type": "file", - "name": "introduction", - "label": "Introduction" + "type": "section-header", + "label": "Essentials" }, { "type": "file", "name": "quick-start", "label": "Quick start" + }, + { + "type": "file", + "name": "configuration", + "label": "Configuration" + }, + { + "type": "dir-section-header", + "name": "cli", + "label": "CLI" } ] diff --git a/website/docs/en/guide/cli/_meta.json b/website/docs/en/guide/cli/_meta.json new file mode 100644 index 0000000..e726f6d --- /dev/null +++ b/website/docs/en/guide/cli/_meta.json @@ -0,0 +1 @@ +["dev", "build", "preview", "lib", "doc", "test", "lint", "staged"] diff --git a/website/docs/en/guide/cli/build.mdx b/website/docs/en/guide/cli/build.mdx new file mode 100644 index 0000000..a1d6424 --- /dev/null +++ b/website/docs/en/guide/cli/build.mdx @@ -0,0 +1,7 @@ +# build + +TODO. + +## Configuration + +See [`define.app()`](../configuration#define-app). diff --git a/website/docs/en/guide/cli/dev.mdx b/website/docs/en/guide/cli/dev.mdx new file mode 100644 index 0000000..b6ea4f8 --- /dev/null +++ b/website/docs/en/guide/cli/dev.mdx @@ -0,0 +1,7 @@ +# dev + +TODO. + +## Configuration + +See [`define.app()`](../configuration#define-app). diff --git a/website/docs/en/guide/cli/doc.mdx b/website/docs/en/guide/cli/doc.mdx new file mode 100644 index 0000000..38eba18 --- /dev/null +++ b/website/docs/en/guide/cli/doc.mdx @@ -0,0 +1,7 @@ +# doc + +TODO. + +## Configuration + +See [`define.doc()`](../configuration#define-doc). diff --git a/website/docs/en/guide/cli/lib.mdx b/website/docs/en/guide/cli/lib.mdx new file mode 100644 index 0000000..e739a43 --- /dev/null +++ b/website/docs/en/guide/cli/lib.mdx @@ -0,0 +1,7 @@ +# lib + +TODO. + +## Configuration + +See [`define.lib()`](../configuration#define-lib). diff --git a/website/docs/en/guide/cli/lint.mdx b/website/docs/en/guide/cli/lint.mdx new file mode 100644 index 0000000..d97b11e --- /dev/null +++ b/website/docs/en/guide/cli/lint.mdx @@ -0,0 +1,7 @@ +# lint + +TODO. + +## Configuration + +See [`define.lint()`](../configuration#define-lint). diff --git a/website/docs/en/guide/cli/preview.mdx b/website/docs/en/guide/cli/preview.mdx new file mode 100644 index 0000000..092f510 --- /dev/null +++ b/website/docs/en/guide/cli/preview.mdx @@ -0,0 +1,7 @@ +# preview + +TODO. + +## Configuration + +See [`define.app()`](../configuration#define-app). diff --git a/website/docs/en/guide/cli/staged.mdx b/website/docs/en/guide/cli/staged.mdx new file mode 100644 index 0000000..6d50557 --- /dev/null +++ b/website/docs/en/guide/cli/staged.mdx @@ -0,0 +1,7 @@ +# staged + +TODO. + +## Configuration + +See [`define.staged()`](../configuration#define-staged). diff --git a/website/docs/en/guide/cli/test.mdx b/website/docs/en/guide/cli/test.mdx new file mode 100644 index 0000000..1b1361b --- /dev/null +++ b/website/docs/en/guide/cli/test.mdx @@ -0,0 +1,7 @@ +# test + +TODO. + +## Configuration + +See [`define.test()`](../configuration#define-test). diff --git a/website/docs/en/guide/configuration.mdx b/website/docs/en/guide/configuration.mdx new file mode 100644 index 0000000..307cc17 --- /dev/null +++ b/website/docs/en/guide/configuration.mdx @@ -0,0 +1,43 @@ +# Configuration + +TODO. + +## `define.app()` \{#define-app} + +TODO. + +Commands: + +- [`rs dev`](./cli/dev) +- [`rs build`](./cli/build) +- [`rs preview`](./cli/preview) + +## `define.lib()` \{#define-lib} + +TODO. + +Command: [`rs lib`](./cli/lib). + +## `define.doc()` \{#define-doc} + +TODO. + +Command: [`rs doc`](./cli/doc). + +## `define.test()` \{#define-test} + +TODO. + +Command: [`rs test`](./cli/test). + +## `define.lint()` \{#define-lint} + +TODO. + +Command: [`rs lint`](./cli/lint). + +## `define.staged()` \{#define-staged} + +TODO. + +Command: [`rs staged`](./cli/staged). diff --git a/website/docs/en/guide/introduction.mdx b/website/docs/en/guide/introduction.mdx deleted file mode 100644 index 474d970..0000000 --- a/website/docs/en/guide/introduction.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Introduction - -TODO. diff --git a/website/docs/en/guide/quick-start.mdx b/website/docs/en/guide/quick-start.mdx index b14d580..41f66b0 100644 --- a/website/docs/en/guide/quick-start.mdx +++ b/website/docs/en/guide/quick-start.mdx @@ -1,3 +1,14 @@ # Quick start TODO. + +## CLI commands + +- [`rs dev`](./cli/dev): TODO. +- [`rs build`](./cli/build): TODO. +- [`rs preview`](./cli/preview): TODO. +- [`rs lib`](./cli/lib): TODO. +- [`rs doc`](./cli/doc): TODO. +- [`rs test`](./cli/test): TODO. +- [`rs lint`](./cli/lint): TODO. +- [`rs staged`](./cli/staged): TODO. diff --git a/website/docs/zh/_nav.json b/website/docs/zh/_nav.json index 79148cf..b1d56dc 100644 --- a/website/docs/zh/_nav.json +++ b/website/docs/zh/_nav.json @@ -1,19 +1,9 @@ [ { "text": "指南", - "link": "/guide/introduction", + "link": "/guide/quick-start", "activeMatch": "/guide/" }, - { - "text": "命令", - "link": "/commands/", - "activeMatch": "/commands/" - }, - { - "text": "配置", - "link": "/config/", - "activeMatch": "/config/" - }, { "text": "更新日志", "link": "https://github.com/rstackjs/rstack-cli/releases" diff --git a/website/docs/zh/commands/_meta.json b/website/docs/zh/commands/_meta.json deleted file mode 100644 index c768285..0000000 --- a/website/docs/zh/commands/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "type": "file", - "name": "index", - "label": "命令概览" - } -] diff --git a/website/docs/zh/commands/index.mdx b/website/docs/zh/commands/index.mdx deleted file mode 100644 index d2d3df0..0000000 --- a/website/docs/zh/commands/index.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# 命令 - -TODO. diff --git a/website/docs/zh/config/_meta.json b/website/docs/zh/config/_meta.json deleted file mode 100644 index 7710d8c..0000000 --- a/website/docs/zh/config/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "type": "file", - "name": "index", - "label": "配置概览" - } -] diff --git a/website/docs/zh/config/index.mdx b/website/docs/zh/config/index.mdx deleted file mode 100644 index 6d71be2..0000000 --- a/website/docs/zh/config/index.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# 配置 - -TODO. diff --git a/website/docs/zh/guide/_meta.json b/website/docs/zh/guide/_meta.json index 504b9ce..1f9fdb5 100644 --- a/website/docs/zh/guide/_meta.json +++ b/website/docs/zh/guide/_meta.json @@ -1,12 +1,21 @@ [ { - "type": "file", - "name": "introduction", - "label": "介绍" + "type": "section-header", + "label": "基础" }, { "type": "file", "name": "quick-start", "label": "快速上手" + }, + { + "type": "file", + "name": "configuration", + "label": "配置" + }, + { + "type": "dir-section-header", + "name": "cli", + "label": "CLI" } ] diff --git a/website/docs/zh/guide/cli/_meta.json b/website/docs/zh/guide/cli/_meta.json new file mode 100644 index 0000000..e726f6d --- /dev/null +++ b/website/docs/zh/guide/cli/_meta.json @@ -0,0 +1 @@ +["dev", "build", "preview", "lib", "doc", "test", "lint", "staged"] diff --git a/website/docs/zh/guide/cli/build.mdx b/website/docs/zh/guide/cli/build.mdx new file mode 100644 index 0000000..9320eff --- /dev/null +++ b/website/docs/zh/guide/cli/build.mdx @@ -0,0 +1,7 @@ +# build + +TODO. + +## 配置 + +参见 [`define.app()`](../configuration#define-app)。 diff --git a/website/docs/zh/guide/cli/dev.mdx b/website/docs/zh/guide/cli/dev.mdx new file mode 100644 index 0000000..67f0877 --- /dev/null +++ b/website/docs/zh/guide/cli/dev.mdx @@ -0,0 +1,7 @@ +# dev + +TODO. + +## 配置 + +参见 [`define.app()`](../configuration#define-app)。 diff --git a/website/docs/zh/guide/cli/doc.mdx b/website/docs/zh/guide/cli/doc.mdx new file mode 100644 index 0000000..33c457b --- /dev/null +++ b/website/docs/zh/guide/cli/doc.mdx @@ -0,0 +1,7 @@ +# doc + +TODO. + +## 配置 + +参见 [`define.doc()`](../configuration#define-doc)。 diff --git a/website/docs/zh/guide/cli/lib.mdx b/website/docs/zh/guide/cli/lib.mdx new file mode 100644 index 0000000..31a0247 --- /dev/null +++ b/website/docs/zh/guide/cli/lib.mdx @@ -0,0 +1,7 @@ +# lib + +TODO. + +## 配置 + +参见 [`define.lib()`](../configuration#define-lib)。 diff --git a/website/docs/zh/guide/cli/lint.mdx b/website/docs/zh/guide/cli/lint.mdx new file mode 100644 index 0000000..1303a4b --- /dev/null +++ b/website/docs/zh/guide/cli/lint.mdx @@ -0,0 +1,7 @@ +# lint + +TODO. + +## 配置 + +参见 [`define.lint()`](../configuration#define-lint)。 diff --git a/website/docs/zh/guide/cli/preview.mdx b/website/docs/zh/guide/cli/preview.mdx new file mode 100644 index 0000000..ba8db6c --- /dev/null +++ b/website/docs/zh/guide/cli/preview.mdx @@ -0,0 +1,7 @@ +# preview + +TODO. + +## 配置 + +参见 [`define.app()`](../configuration#define-app)。 diff --git a/website/docs/zh/guide/cli/staged.mdx b/website/docs/zh/guide/cli/staged.mdx new file mode 100644 index 0000000..af04032 --- /dev/null +++ b/website/docs/zh/guide/cli/staged.mdx @@ -0,0 +1,7 @@ +# staged + +TODO. + +## 配置 + +参见 [`define.staged()`](../configuration#define-staged)。 diff --git a/website/docs/zh/guide/cli/test.mdx b/website/docs/zh/guide/cli/test.mdx new file mode 100644 index 0000000..20582a5 --- /dev/null +++ b/website/docs/zh/guide/cli/test.mdx @@ -0,0 +1,7 @@ +# test + +TODO. + +## 配置 + +参见 [`define.test()`](../configuration#define-test)。 diff --git a/website/docs/zh/guide/configuration.mdx b/website/docs/zh/guide/configuration.mdx new file mode 100644 index 0000000..c67524c --- /dev/null +++ b/website/docs/zh/guide/configuration.mdx @@ -0,0 +1,43 @@ +# 配置 + +TODO. + +## `define.app()` \{#define-app} + +TODO. + +对应命令： + +- [`rs dev`](./cli/dev) +- [`rs build`](./cli/build) +- [`rs preview`](./cli/preview) + +## `define.lib()` \{#define-lib} + +TODO. + +对应命令：[`rs lib`](./cli/lib)。 + +## `define.doc()` \{#define-doc} + +TODO. + +对应命令：[`rs doc`](./cli/doc)。 + +## `define.test()` \{#define-test} + +TODO. + +对应命令：[`rs test`](./cli/test)。 + +## `define.lint()` \{#define-lint} + +TODO. + +对应命令：[`rs lint`](./cli/lint)。 + +## `define.staged()` \{#define-staged} + +TODO. + +对应命令：[`rs staged`](./cli/staged)。 diff --git a/website/docs/zh/guide/introduction.mdx b/website/docs/zh/guide/introduction.mdx deleted file mode 100644 index 6214f1e..0000000 --- a/website/docs/zh/guide/introduction.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# 介绍 - -TODO. diff --git a/website/docs/zh/guide/quick-start.mdx b/website/docs/zh/guide/quick-start.mdx index 17e21f8..ac48d7b 100644 --- a/website/docs/zh/guide/quick-start.mdx +++ b/website/docs/zh/guide/quick-start.mdx @@ -1,3 +1,14 @@ # 快速上手 TODO. + +## CLI 命令 + +- [`rs dev`](./cli/dev)：TODO。 +- [`rs build`](./cli/build)：TODO。 +- [`rs preview`](./cli/preview)：TODO。 +- [`rs lib`](./cli/lib)：TODO。 +- [`rs doc`](./cli/doc)：TODO。 +- [`rs test`](./cli/test)：TODO。 +- [`rs lint`](./cli/lint)：TODO。 +- [`rs staged`](./cli/staged)：TODO。 diff --git a/website/i18n.json b/website/i18n.json index 07efe7b..b253a42 100644 --- a/website/i18n.json +++ b/website/i18n.json @@ -1,8 +1,4 @@ { - "introduction": { - "en": "Introduction", - "zh": "介绍" - }, "quickStart": { "en": "Quick start", "zh": "快速上手" diff --git a/website/theme/components/HomeFooter.tsx b/website/theme/components/HomeFooter.tsx index d3e764d..4780c28 100644 --- a/website/theme/components/HomeFooter.tsx +++ b/website/theme/components/HomeFooter.tsx @@ -12,17 +12,13 @@ function useFooterData() { { title: t('guide'), items: [ - { - title: t('introduction'), - link: getLink('/guide/introduction'), - }, { title: t('quickStart'), link: getLink('/guide/quick-start'), }, { title: t('configuration'), - link: getLink('/config/index'), + link: getLink('/guide/configuration'), }, ], }, @@ -30,20 +26,16 @@ function useFooterData() { title: t('commands'), items: [ { - title: t('commands'), - link: getLink('/commands/index'), - }, - { - title: 'rs dev / rs build', - link: getLink('/commands/index'), + title: 'rs dev', + link: getLink('/guide/cli/dev'), }, { - title: 'rs test / rs lint', - link: getLink('/commands/index'), + title: 'rs build', + link: getLink('/guide/cli/build'), }, { - title: 'rs lib / rs doc', - link: getLink('/commands/index'), + title: 'rs test', + link: getLink('/guide/cli/test'), }, ], },