diff --git a/website/docs/en/_meta.json b/website/docs/en/_meta.json index 988672017..d32213ab5 100644 --- a/website/docs/en/_meta.json +++ b/website/docs/en/_meta.json @@ -8,5 +8,15 @@ "text": "Config", "link": "/config/", "activeMatch": "/config/" + }, + { + "text": "API", + "link": "/api/javascript-api/core", + "activeMatch": "/api/" + }, + { + "text": "Blog", + "link": "/blog/", + "activeMatch": "/blog/" } ] diff --git a/website/docs/en/api/_meta.json b/website/docs/en/api/_meta.json new file mode 100644 index 000000000..273bef352 --- /dev/null +++ b/website/docs/en/api/_meta.json @@ -0,0 +1,7 @@ +[ + { + "type": "dir", + "name": "javascript-api", + "label": "JavaScript API" + } +] diff --git a/website/docs/en/api/javascript-api/_meta.json b/website/docs/en/api/javascript-api/_meta.json new file mode 100644 index 000000000..429de3585 --- /dev/null +++ b/website/docs/en/api/javascript-api/_meta.json @@ -0,0 +1 @@ +["core", "types"] diff --git a/website/docs/en/api/javascript-api/core.mdx b/website/docs/en/api/javascript-api/core.mdx new file mode 100644 index 000000000..1d0fa8ea4 --- /dev/null +++ b/website/docs/en/api/javascript-api/core.mdx @@ -0,0 +1 @@ +# Rslib Core diff --git a/website/docs/en/api/javascript-api/types.mdx b/website/docs/en/api/javascript-api/types.mdx new file mode 100644 index 000000000..c8e180515 --- /dev/null +++ b/website/docs/en/api/javascript-api/types.mdx @@ -0,0 +1 @@ +# Rslib Types diff --git a/website/docs/en/blog/_meta.json b/website/docs/en/blog/_meta.json new file mode 100644 index 000000000..a7d5eda49 --- /dev/null +++ b/website/docs/en/blog/_meta.json @@ -0,0 +1 @@ +["index"] diff --git a/website/docs/en/blog/index.mdx b/website/docs/en/blog/index.mdx new file mode 100644 index 000000000..d932377e1 --- /dev/null +++ b/website/docs/en/blog/index.mdx @@ -0,0 +1,7 @@ +--- +title: Overview +--- + +# Rslib Blogs + +Check here for the latest articles and release announcements about Rslib. diff --git a/website/docs/en/config/_meta.json b/website/docs/en/config/_meta.json index 60cbc6f05..4a47e771a 100644 --- a/website/docs/en/config/_meta.json +++ b/website/docs/en/config/_meta.json @@ -2,11 +2,16 @@ { "type": "file", "name": "index", - "label": "Overview" + "label": "Config Overview" }, { "type": "dir", "name": "lib", - "label": "lib" + "label": "Lib" + }, + { + "type": "dir", + "name": "rsbuild", + "label": "Rsbuild Config" } ] diff --git a/website/docs/en/config/index.mdx b/website/docs/en/config/index.mdx index 2fdf3693c..0a97215eb 100644 --- a/website/docs/en/config/index.mdx +++ b/website/docs/en/config/index.mdx @@ -1,3 +1,6 @@ -# Config Overview +--- +overview: true +title: Config Overview +--- -This page lists all the configurations for Rslib. See ["Configure Rslib"](/guide/basic/configure-rslib) for detail. +This page lists all the configurations for Rslib. See [Configure Rslib](/guide/basic/configure-rslib) for detail. diff --git a/website/docs/en/config/lib.mdx b/website/docs/en/config/lib.mdx new file mode 100644 index 000000000..e61353ed6 --- /dev/null +++ b/website/docs/en/config/lib.mdx @@ -0,0 +1 @@ +# Lib diff --git a/website/docs/en/config/lib/_meta.json b/website/docs/en/config/lib/_meta.json new file mode 100644 index 000000000..194457734 --- /dev/null +++ b/website/docs/en/config/lib/_meta.json @@ -0,0 +1,14 @@ +[ + "bundle", + "format", + "auto-extension", + "auto-external", + "redirect", + "syntax", + "external-helpers", + "banner", + "footer", + "dts", + "shims", + "umd-name" +] diff --git a/website/docs/en/config/lib/auto-extension.mdx b/website/docs/en/config/lib/auto-extension.mdx new file mode 100644 index 000000000..7d736367a --- /dev/null +++ b/website/docs/en/config/lib/auto-extension.mdx @@ -0,0 +1 @@ +# lib.autoExtension diff --git a/website/docs/en/config/lib/auto-external.mdx b/website/docs/en/config/lib/auto-external.mdx new file mode 100644 index 000000000..72d46bc27 --- /dev/null +++ b/website/docs/en/config/lib/auto-external.mdx @@ -0,0 +1 @@ +# lib.autoExternal diff --git a/website/docs/en/config/lib/banner.mdx b/website/docs/en/config/lib/banner.mdx new file mode 100644 index 000000000..7f8290e58 --- /dev/null +++ b/website/docs/en/config/lib/banner.mdx @@ -0,0 +1 @@ +# lib.banner diff --git a/website/docs/en/config/lib/bundle.mdx b/website/docs/en/config/lib/bundle.mdx new file mode 100644 index 000000000..da9ef7c32 --- /dev/null +++ b/website/docs/en/config/lib/bundle.mdx @@ -0,0 +1 @@ +# lib.bundle diff --git a/website/docs/en/config/lib/dts.mdx b/website/docs/en/config/lib/dts.mdx new file mode 100644 index 000000000..52d3be121 --- /dev/null +++ b/website/docs/en/config/lib/dts.mdx @@ -0,0 +1 @@ +# lib.dts diff --git a/website/docs/en/config/lib/external-helpers.mdx b/website/docs/en/config/lib/external-helpers.mdx new file mode 100644 index 000000000..0742c9ce4 --- /dev/null +++ b/website/docs/en/config/lib/external-helpers.mdx @@ -0,0 +1 @@ +# lib.externalHelpers diff --git a/website/docs/en/config/lib/footer.mdx b/website/docs/en/config/lib/footer.mdx new file mode 100644 index 000000000..064072b6d --- /dev/null +++ b/website/docs/en/config/lib/footer.mdx @@ -0,0 +1 @@ +# lib.footer diff --git a/website/docs/en/config/lib/format.mdx b/website/docs/en/config/lib/format.mdx new file mode 100644 index 000000000..a6428bf66 --- /dev/null +++ b/website/docs/en/config/lib/format.mdx @@ -0,0 +1 @@ +# lib.format diff --git a/website/docs/en/config/lib/redirect.mdx b/website/docs/en/config/lib/redirect.mdx new file mode 100644 index 000000000..3f144c2e4 --- /dev/null +++ b/website/docs/en/config/lib/redirect.mdx @@ -0,0 +1 @@ +# lib.redirect diff --git a/website/docs/en/config/lib/shims.mdx b/website/docs/en/config/lib/shims.mdx index db43258ac..659616b44 100644 --- a/website/docs/en/config/lib/shims.mdx +++ b/website/docs/en/config/lib/shims.mdx @@ -1,3 +1,7 @@ +--- +overviewHeaders: [2, 3] +--- + # lib.shims - **Type:** diff --git a/website/docs/en/config/lib/syntax.mdx b/website/docs/en/config/lib/syntax.mdx new file mode 100644 index 000000000..89cf6a15a --- /dev/null +++ b/website/docs/en/config/lib/syntax.mdx @@ -0,0 +1 @@ +# lib.syntax diff --git a/website/docs/en/config/lib/umd-name.mdx b/website/docs/en/config/lib/umd-name.mdx new file mode 100644 index 000000000..0ef9a503e --- /dev/null +++ b/website/docs/en/config/lib/umd-name.mdx @@ -0,0 +1 @@ +# lib.umdName diff --git a/website/docs/en/config/rsbuild.mdx b/website/docs/en/config/rsbuild.mdx new file mode 100644 index 000000000..6c0b6b446 --- /dev/null +++ b/website/docs/en/config/rsbuild.mdx @@ -0,0 +1 @@ +# Rsbuild 配置 diff --git a/website/docs/en/config/rsbuild/_meta.json b/website/docs/en/config/rsbuild/_meta.json new file mode 100644 index 000000000..258e26896 --- /dev/null +++ b/website/docs/en/config/rsbuild/_meta.json @@ -0,0 +1 @@ +["plugins", "source", "output", "tools"] diff --git a/website/docs/en/config/rsbuild/output.mdx b/website/docs/en/config/rsbuild/output.mdx new file mode 100644 index 000000000..2580f6310 --- /dev/null +++ b/website/docs/en/config/rsbuild/output.mdx @@ -0,0 +1 @@ +# output diff --git a/website/docs/en/config/rsbuild/plugins.mdx b/website/docs/en/config/rsbuild/plugins.mdx new file mode 100644 index 000000000..f130fd14e --- /dev/null +++ b/website/docs/en/config/rsbuild/plugins.mdx @@ -0,0 +1 @@ +# plugins diff --git a/website/docs/en/config/rsbuild/source.mdx b/website/docs/en/config/rsbuild/source.mdx new file mode 100644 index 000000000..5acc8032f --- /dev/null +++ b/website/docs/en/config/rsbuild/source.mdx @@ -0,0 +1 @@ +# source diff --git a/website/docs/en/config/rsbuild/tools.mdx b/website/docs/en/config/rsbuild/tools.mdx new file mode 100644 index 000000000..896a03e8d --- /dev/null +++ b/website/docs/en/config/rsbuild/tools.mdx @@ -0,0 +1 @@ +# tools diff --git a/website/docs/en/guide/_meta.json b/website/docs/en/guide/_meta.json index 3fb5f7dc2..1699f5c75 100644 --- a/website/docs/en/guide/_meta.json +++ b/website/docs/en/guide/_meta.json @@ -13,5 +13,20 @@ "type": "dir", "name": "advanced", "label": "Advanced" + }, + { + "type": "dir", + "name": "migration", + "label": "Migration" + }, + { + "type": "dir", + "name": "debug", + "label": "Debug" + }, + { + "type": "dir", + "name": "faq", + "label": "FAQ" } ] diff --git a/website/docs/en/guide/advanced/_meta.json b/website/docs/en/guide/advanced/_meta.json index cf5a3dc6b..381d84627 100644 --- a/website/docs/en/guide/advanced/_meta.json +++ b/website/docs/en/guide/advanced/_meta.json @@ -1 +1,13 @@ -["module-federation"] +[ + "package-json", + "templates", + "third-party-deps", + "polyfill", + "css", + "assets", + "dts", + "module-federation", + "module-doc", + "storybook", + "monorepo" +] diff --git a/website/docs/en/guide/advanced/assets.mdx b/website/docs/en/guide/advanced/assets.mdx new file mode 100644 index 000000000..5d1b13d50 --- /dev/null +++ b/website/docs/en/guide/advanced/assets.mdx @@ -0,0 +1 @@ +# Assets diff --git a/website/docs/en/guide/advanced/css.mdx b/website/docs/en/guide/advanced/css.mdx new file mode 100644 index 000000000..1167bf8c0 --- /dev/null +++ b/website/docs/en/guide/advanced/css.mdx @@ -0,0 +1 @@ +# CSS diff --git a/website/docs/en/guide/advanced/dts.mdx b/website/docs/en/guide/advanced/dts.mdx new file mode 100644 index 000000000..0a863508d --- /dev/null +++ b/website/docs/en/guide/advanced/dts.mdx @@ -0,0 +1 @@ +# DTS diff --git a/website/docs/en/guide/advanced/module-doc.mdx b/website/docs/en/guide/advanced/module-doc.mdx new file mode 100644 index 000000000..7bd114c55 --- /dev/null +++ b/website/docs/en/guide/advanced/module-doc.mdx @@ -0,0 +1 @@ +# Module Doc diff --git a/website/docs/en/guide/advanced/monorepo.mdx b/website/docs/en/guide/advanced/monorepo.mdx new file mode 100644 index 000000000..11636556f --- /dev/null +++ b/website/docs/en/guide/advanced/monorepo.mdx @@ -0,0 +1 @@ +# Monorepo diff --git a/website/docs/en/guide/advanced/package-json.mdx b/website/docs/en/guide/advanced/package-json.mdx new file mode 100644 index 000000000..3cc262d59 --- /dev/null +++ b/website/docs/en/guide/advanced/package-json.mdx @@ -0,0 +1 @@ +# Write package.json diff --git a/website/docs/en/guide/advanced/polyfill.mdx b/website/docs/en/guide/advanced/polyfill.mdx new file mode 100644 index 000000000..b7c0b37fe --- /dev/null +++ b/website/docs/en/guide/advanced/polyfill.mdx @@ -0,0 +1 @@ +# Target and Polyfill diff --git a/website/docs/en/guide/advanced/storybook.mdx b/website/docs/en/guide/advanced/storybook.mdx new file mode 100644 index 000000000..c1a98bb27 --- /dev/null +++ b/website/docs/en/guide/advanced/storybook.mdx @@ -0,0 +1 @@ +# Use Storybook diff --git a/website/docs/en/guide/advanced/templates.mdx b/website/docs/en/guide/advanced/templates.mdx new file mode 100644 index 000000000..684234ff4 --- /dev/null +++ b/website/docs/en/guide/advanced/templates.mdx @@ -0,0 +1 @@ +# Templates diff --git a/website/docs/en/guide/advanced/third-party-deps.mdx b/website/docs/en/guide/advanced/third-party-deps.mdx new file mode 100644 index 000000000..40af82a4b --- /dev/null +++ b/website/docs/en/guide/advanced/third-party-deps.mdx @@ -0,0 +1 @@ +# Handle Third-party Dependencies diff --git a/website/docs/en/guide/basic/_meta.json b/website/docs/en/guide/basic/_meta.json index a17e167b0..8d965b8e1 100644 --- a/website/docs/en/guide/basic/_meta.json +++ b/website/docs/en/guide/basic/_meta.json @@ -1 +1,11 @@ -["configure-rslib", "UMD"] +[ + "cli", + "configure-rslib", + "configure-rsbuild-rspack", + "typescript-usage", + "output-files", + "bundle-mode", + "upgrade-rslib", + "cjs-esm", + "umd" +] diff --git a/website/docs/en/guide/basic/bundle-mode.mdx b/website/docs/en/guide/basic/bundle-mode.mdx new file mode 100644 index 000000000..7c13536c9 --- /dev/null +++ b/website/docs/en/guide/basic/bundle-mode.mdx @@ -0,0 +1 @@ +# Select Bundle Mode diff --git a/website/docs/en/guide/basic/cjs-esm.mdx b/website/docs/en/guide/basic/cjs-esm.mdx new file mode 100644 index 000000000..cfa881420 --- /dev/null +++ b/website/docs/en/guide/basic/cjs-esm.mdx @@ -0,0 +1 @@ +# CJS and ESM diff --git a/website/docs/en/guide/basic/cli.mdx b/website/docs/en/guide/basic/cli.mdx new file mode 100644 index 000000000..3f213d436 --- /dev/null +++ b/website/docs/en/guide/basic/cli.mdx @@ -0,0 +1 @@ +# CLI diff --git a/website/docs/en/guide/basic/configure-rsbuild-rspack.mdx b/website/docs/en/guide/basic/configure-rsbuild-rspack.mdx new file mode 100644 index 000000000..63148803b --- /dev/null +++ b/website/docs/en/guide/basic/configure-rsbuild-rspack.mdx @@ -0,0 +1 @@ +# Configure Rsbuild / Rspack diff --git a/website/docs/en/guide/basic/output-files.mdx b/website/docs/en/guide/basic/output-files.mdx new file mode 100644 index 000000000..0132e16c0 --- /dev/null +++ b/website/docs/en/guide/basic/output-files.mdx @@ -0,0 +1 @@ +# Output Files diff --git a/website/docs/en/guide/basic/typescript-usage.mdx b/website/docs/en/guide/basic/typescript-usage.mdx new file mode 100644 index 000000000..e7452683b --- /dev/null +++ b/website/docs/en/guide/basic/typescript-usage.mdx @@ -0,0 +1 @@ +# Use Typescript diff --git a/website/docs/en/guide/basic/UMD.mdx b/website/docs/en/guide/basic/umd.mdx similarity index 100% rename from website/docs/en/guide/basic/UMD.mdx rename to website/docs/en/guide/basic/umd.mdx diff --git a/website/docs/en/guide/basic/upgrade-rslib.mdx b/website/docs/en/guide/basic/upgrade-rslib.mdx new file mode 100644 index 000000000..990dcbe0b --- /dev/null +++ b/website/docs/en/guide/basic/upgrade-rslib.mdx @@ -0,0 +1 @@ +# Upgrade Rslib diff --git a/website/docs/en/guide/debug/_meta.json b/website/docs/en/guide/debug/_meta.json new file mode 100644 index 000000000..5ec4cb842 --- /dev/null +++ b/website/docs/en/guide/debug/_meta.json @@ -0,0 +1 @@ +["debug-mode", "build-profiling", "rsdoctor"] diff --git a/website/docs/en/guide/debug/build-profiling.mdx b/website/docs/en/guide/debug/build-profiling.mdx new file mode 100644 index 000000000..c222cfa38 --- /dev/null +++ b/website/docs/en/guide/debug/build-profiling.mdx @@ -0,0 +1 @@ +# Build Profiling diff --git a/website/docs/en/guide/debug/debug-mode.mdx b/website/docs/en/guide/debug/debug-mode.mdx new file mode 100644 index 000000000..7702d70a4 --- /dev/null +++ b/website/docs/en/guide/debug/debug-mode.mdx @@ -0,0 +1 @@ +# Debug Mode diff --git a/website/docs/en/guide/debug/rsdoctor.mdx b/website/docs/en/guide/debug/rsdoctor.mdx new file mode 100644 index 000000000..6c2af4f4e --- /dev/null +++ b/website/docs/en/guide/debug/rsdoctor.mdx @@ -0,0 +1 @@ +# Use Rsdoctor diff --git a/website/docs/en/guide/faq/_meta.json b/website/docs/en/guide/faq/_meta.json new file mode 100644 index 000000000..7e1ef5ec4 --- /dev/null +++ b/website/docs/en/guide/faq/_meta.json @@ -0,0 +1 @@ +["general", "features", "exceptions"] diff --git a/website/docs/en/guide/faq/exceptions.mdx b/website/docs/en/guide/faq/exceptions.mdx new file mode 100644 index 000000000..c9d081e3a --- /dev/null +++ b/website/docs/en/guide/faq/exceptions.mdx @@ -0,0 +1 @@ +# Exceptions FAQ diff --git a/website/docs/en/guide/faq/features.mdx b/website/docs/en/guide/faq/features.mdx new file mode 100644 index 000000000..16a5f3c3e --- /dev/null +++ b/website/docs/en/guide/faq/features.mdx @@ -0,0 +1 @@ +# Features FAQ diff --git a/website/docs/en/guide/faq/general.mdx b/website/docs/en/guide/faq/general.mdx new file mode 100644 index 000000000..e5a6958d3 --- /dev/null +++ b/website/docs/en/guide/faq/general.mdx @@ -0,0 +1 @@ +# General FAQ diff --git a/website/docs/en/guide/framework/_meta.json b/website/docs/en/guide/framework/_meta.json new file mode 100644 index 000000000..d68a725ef --- /dev/null +++ b/website/docs/en/guide/framework/_meta.json @@ -0,0 +1 @@ +["typescript", "react", "vue"] diff --git a/website/docs/en/guide/framework/react.mdx b/website/docs/en/guide/framework/react.mdx new file mode 100644 index 000000000..4a55d1124 --- /dev/null +++ b/website/docs/en/guide/framework/react.mdx @@ -0,0 +1 @@ +# React diff --git a/website/docs/en/guide/framework/typescript.mdx b/website/docs/en/guide/framework/typescript.mdx new file mode 100644 index 000000000..42c977580 --- /dev/null +++ b/website/docs/en/guide/framework/typescript.mdx @@ -0,0 +1 @@ +# Typescript diff --git a/website/docs/en/guide/framework/vue.mdx b/website/docs/en/guide/framework/vue.mdx new file mode 100644 index 000000000..9d38c2e9d --- /dev/null +++ b/website/docs/en/guide/framework/vue.mdx @@ -0,0 +1 @@ +# Vue diff --git a/website/docs/en/guide/migration/_meta.json b/website/docs/en/guide/migration/_meta.json new file mode 100644 index 000000000..6f21679f2 --- /dev/null +++ b/website/docs/en/guide/migration/_meta.json @@ -0,0 +1 @@ +["modernjs-module", "tsup", "rollup", "esbuild"] diff --git a/website/docs/en/guide/migration/esbuild.mdx b/website/docs/en/guide/migration/esbuild.mdx new file mode 100644 index 000000000..1d625c5a9 --- /dev/null +++ b/website/docs/en/guide/migration/esbuild.mdx @@ -0,0 +1 @@ +# esbuild diff --git a/website/docs/en/guide/migration/modernjs-module.mdx b/website/docs/en/guide/migration/modernjs-module.mdx new file mode 100644 index 000000000..e435abd7f --- /dev/null +++ b/website/docs/en/guide/migration/modernjs-module.mdx @@ -0,0 +1 @@ +# Modern.js Module diff --git a/website/docs/en/guide/migration/rollup.mdx b/website/docs/en/guide/migration/rollup.mdx new file mode 100644 index 000000000..37db6ad52 --- /dev/null +++ b/website/docs/en/guide/migration/rollup.mdx @@ -0,0 +1 @@ +# rollup diff --git a/website/docs/en/guide/migration/tsup.mdx b/website/docs/en/guide/migration/tsup.mdx new file mode 100644 index 000000000..d514e9899 --- /dev/null +++ b/website/docs/en/guide/migration/tsup.mdx @@ -0,0 +1 @@ +# tsup diff --git a/website/docs/en/guide/start/_meta.json b/website/docs/en/guide/start/_meta.json index 8a5be8c86..e2cb04931 100644 --- a/website/docs/en/guide/start/_meta.json +++ b/website/docs/en/guide/start/_meta.json @@ -1 +1 @@ -["index", "quick-start", "features"] +["index", "quick-start", "features", "glossary", "npm-packages"] diff --git a/website/docs/en/guide/start/glossary.mdx b/website/docs/en/guide/start/glossary.mdx new file mode 100644 index 000000000..ca3c82769 --- /dev/null +++ b/website/docs/en/guide/start/glossary.mdx @@ -0,0 +1 @@ +# Glossary diff --git a/website/docs/en/guide/start/npm-packages.mdx b/website/docs/en/guide/start/npm-packages.mdx new file mode 100644 index 000000000..3fbbc74f7 --- /dev/null +++ b/website/docs/en/guide/start/npm-packages.mdx @@ -0,0 +1 @@ +# Packages diff --git a/website/docs/zh/_meta.json b/website/docs/zh/_meta.json index cfb9c2eeb..a89e83d15 100644 --- a/website/docs/zh/_meta.json +++ b/website/docs/zh/_meta.json @@ -3,5 +3,20 @@ "text": "指南", "link": "/guide/start/", "activeMatch": "/guide/" + }, + { + "text": "配置", + "link": "/config/", + "activeMatch": "/config/" + }, + { + "text": "API", + "link": "/api/javascript-api/core", + "activeMatch": "/api/" + }, + { + "text": "博客", + "link": "/blog/", + "activeMatch": "/blog/" } ] diff --git a/website/docs/zh/api/_meta.json b/website/docs/zh/api/_meta.json new file mode 100644 index 000000000..273bef352 --- /dev/null +++ b/website/docs/zh/api/_meta.json @@ -0,0 +1,7 @@ +[ + { + "type": "dir", + "name": "javascript-api", + "label": "JavaScript API" + } +] diff --git a/website/docs/zh/api/javascript-api/_meta.json b/website/docs/zh/api/javascript-api/_meta.json new file mode 100644 index 000000000..429de3585 --- /dev/null +++ b/website/docs/zh/api/javascript-api/_meta.json @@ -0,0 +1 @@ +["core", "types"] diff --git a/website/docs/zh/api/javascript-api/core.mdx b/website/docs/zh/api/javascript-api/core.mdx new file mode 100644 index 000000000..1d0fa8ea4 --- /dev/null +++ b/website/docs/zh/api/javascript-api/core.mdx @@ -0,0 +1 @@ +# Rslib Core diff --git a/website/docs/zh/api/javascript-api/types.mdx b/website/docs/zh/api/javascript-api/types.mdx new file mode 100644 index 000000000..c8e180515 --- /dev/null +++ b/website/docs/zh/api/javascript-api/types.mdx @@ -0,0 +1 @@ +# Rslib Types diff --git a/website/docs/zh/blog/_meta.json b/website/docs/zh/blog/_meta.json new file mode 100644 index 000000000..a7d5eda49 --- /dev/null +++ b/website/docs/zh/blog/_meta.json @@ -0,0 +1 @@ +["index"] diff --git a/website/docs/zh/blog/index.mdx b/website/docs/zh/blog/index.mdx new file mode 100644 index 000000000..40e14abc5 --- /dev/null +++ b/website/docs/zh/blog/index.mdx @@ -0,0 +1,7 @@ +--- +title: 总览 +--- + +# Rslib 博客 + +在此查看有关 Rslib 的最新文章和发布公告。 diff --git a/website/docs/zh/config/_meta.json b/website/docs/zh/config/_meta.json new file mode 100644 index 000000000..db20c0487 --- /dev/null +++ b/website/docs/zh/config/_meta.json @@ -0,0 +1,17 @@ +[ + { + "type": "file", + "name": "index", + "label": "配置总览" + }, + { + "type": "dir", + "name": "lib", + "label": "Lib" + }, + { + "type": "dir", + "name": "rsbuild", + "label": "Rsbuild 配置" + } +] diff --git a/website/docs/zh/config/index.mdx b/website/docs/zh/config/index.mdx new file mode 100644 index 000000000..f37a60142 --- /dev/null +++ b/website/docs/zh/config/index.mdx @@ -0,0 +1,6 @@ +--- +overview: true +title: 配置总览 +--- + +本页列出了 Rslib 的所有配置。有关详细信息，请参阅 [配置 Rslib](/guide/basic/configure-rslib)。 diff --git a/website/docs/zh/config/lib.mdx b/website/docs/zh/config/lib.mdx new file mode 100644 index 000000000..e61353ed6 --- /dev/null +++ b/website/docs/zh/config/lib.mdx @@ -0,0 +1 @@ +# Lib diff --git a/website/docs/zh/config/lib/_meta.json b/website/docs/zh/config/lib/_meta.json new file mode 100644 index 000000000..194457734 --- /dev/null +++ b/website/docs/zh/config/lib/_meta.json @@ -0,0 +1,14 @@ +[ + "bundle", + "format", + "auto-extension", + "auto-external", + "redirect", + "syntax", + "external-helpers", + "banner", + "footer", + "dts", + "shims", + "umd-name" +] diff --git a/website/docs/zh/config/lib/auto-extension.mdx b/website/docs/zh/config/lib/auto-extension.mdx new file mode 100644 index 000000000..7d736367a --- /dev/null +++ b/website/docs/zh/config/lib/auto-extension.mdx @@ -0,0 +1 @@ +# lib.autoExtension diff --git a/website/docs/zh/config/lib/auto-external.mdx b/website/docs/zh/config/lib/auto-external.mdx new file mode 100644 index 000000000..72d46bc27 --- /dev/null +++ b/website/docs/zh/config/lib/auto-external.mdx @@ -0,0 +1 @@ +# lib.autoExternal diff --git a/website/docs/zh/config/lib/banner.mdx b/website/docs/zh/config/lib/banner.mdx new file mode 100644 index 000000000..7f8290e58 --- /dev/null +++ b/website/docs/zh/config/lib/banner.mdx @@ -0,0 +1 @@ +# lib.banner diff --git a/website/docs/zh/config/lib/bundle.mdx b/website/docs/zh/config/lib/bundle.mdx new file mode 100644 index 000000000..da9ef7c32 --- /dev/null +++ b/website/docs/zh/config/lib/bundle.mdx @@ -0,0 +1 @@ +# lib.bundle diff --git a/website/docs/zh/config/lib/dts.mdx b/website/docs/zh/config/lib/dts.mdx new file mode 100644 index 000000000..52d3be121 --- /dev/null +++ b/website/docs/zh/config/lib/dts.mdx @@ -0,0 +1 @@ +# lib.dts diff --git a/website/docs/zh/config/lib/external-helpers.mdx b/website/docs/zh/config/lib/external-helpers.mdx new file mode 100644 index 000000000..0742c9ce4 --- /dev/null +++ b/website/docs/zh/config/lib/external-helpers.mdx @@ -0,0 +1 @@ +# lib.externalHelpers diff --git a/website/docs/zh/config/lib/footer.mdx b/website/docs/zh/config/lib/footer.mdx new file mode 100644 index 000000000..064072b6d --- /dev/null +++ b/website/docs/zh/config/lib/footer.mdx @@ -0,0 +1 @@ +# lib.footer diff --git a/website/docs/zh/config/lib/format.mdx b/website/docs/zh/config/lib/format.mdx new file mode 100644 index 000000000..a6428bf66 --- /dev/null +++ b/website/docs/zh/config/lib/format.mdx @@ -0,0 +1 @@ +# lib.format diff --git a/website/docs/zh/config/lib/redirect.mdx b/website/docs/zh/config/lib/redirect.mdx new file mode 100644 index 000000000..3f144c2e4 --- /dev/null +++ b/website/docs/zh/config/lib/redirect.mdx @@ -0,0 +1 @@ +# lib.redirect diff --git a/website/docs/zh/config/lib/shims.mdx b/website/docs/zh/config/lib/shims.mdx new file mode 100644 index 000000000..66bcb9301 --- /dev/null +++ b/website/docs/zh/config/lib/shims.mdx @@ -0,0 +1,5 @@ +--- +overviewHeaders: [2, 3] +--- + +# lib.shims diff --git a/website/docs/zh/config/lib/syntax.mdx b/website/docs/zh/config/lib/syntax.mdx new file mode 100644 index 000000000..89cf6a15a --- /dev/null +++ b/website/docs/zh/config/lib/syntax.mdx @@ -0,0 +1 @@ +# lib.syntax diff --git a/website/docs/zh/config/lib/umd-name.mdx b/website/docs/zh/config/lib/umd-name.mdx new file mode 100644 index 000000000..0ef9a503e --- /dev/null +++ b/website/docs/zh/config/lib/umd-name.mdx @@ -0,0 +1 @@ +# lib.umdName diff --git a/website/docs/zh/config/rsbuild.mdx b/website/docs/zh/config/rsbuild.mdx new file mode 100644 index 000000000..6c0b6b446 --- /dev/null +++ b/website/docs/zh/config/rsbuild.mdx @@ -0,0 +1 @@ +# Rsbuild 配置 diff --git a/website/docs/zh/config/rsbuild/_meta.json b/website/docs/zh/config/rsbuild/_meta.json new file mode 100644 index 000000000..258e26896 --- /dev/null +++ b/website/docs/zh/config/rsbuild/_meta.json @@ -0,0 +1 @@ +["plugins", "source", "output", "tools"] diff --git a/website/docs/zh/config/rsbuild/output.mdx b/website/docs/zh/config/rsbuild/output.mdx new file mode 100644 index 000000000..2580f6310 --- /dev/null +++ b/website/docs/zh/config/rsbuild/output.mdx @@ -0,0 +1 @@ +# output diff --git a/website/docs/zh/config/rsbuild/plugins.mdx b/website/docs/zh/config/rsbuild/plugins.mdx new file mode 100644 index 000000000..f130fd14e --- /dev/null +++ b/website/docs/zh/config/rsbuild/plugins.mdx @@ -0,0 +1 @@ +# plugins diff --git a/website/docs/zh/config/rsbuild/source.mdx b/website/docs/zh/config/rsbuild/source.mdx new file mode 100644 index 000000000..5acc8032f --- /dev/null +++ b/website/docs/zh/config/rsbuild/source.mdx @@ -0,0 +1 @@ +# source diff --git a/website/docs/zh/config/rsbuild/tools.mdx b/website/docs/zh/config/rsbuild/tools.mdx new file mode 100644 index 000000000..896a03e8d --- /dev/null +++ b/website/docs/zh/config/rsbuild/tools.mdx @@ -0,0 +1 @@ +# tools diff --git a/website/docs/zh/guide/_meta.json b/website/docs/zh/guide/_meta.json index da794eff1..f52ee691e 100644 --- a/website/docs/zh/guide/_meta.json +++ b/website/docs/zh/guide/_meta.json @@ -4,6 +4,11 @@ "name": "start", "label": "开始" }, + { + "type": "dir", + "name": "framework", + "label": "语言与框架" + }, { "type": "dir", "name": "basic", @@ -13,5 +18,20 @@ "type": "dir", "name": "advanced", "label": "进阶" + }, + { + "type": "dir", + "name": "migration", + "label": "迁移" + }, + { + "type": "dir", + "name": "debug", + "label": "调试" + }, + { + "type": "dir", + "name": "faq", + "label": "常见问题" } ] diff --git a/website/docs/zh/guide/advanced/_meta.json b/website/docs/zh/guide/advanced/_meta.json index cf5a3dc6b..381d84627 100644 --- a/website/docs/zh/guide/advanced/_meta.json +++ b/website/docs/zh/guide/advanced/_meta.json @@ -1 +1,13 @@ -["module-federation"] +[ + "package-json", + "templates", + "third-party-deps", + "polyfill", + "css", + "assets", + "dts", + "module-federation", + "module-doc", + "storybook", + "monorepo" +] diff --git a/website/docs/zh/guide/advanced/assets.mdx b/website/docs/zh/guide/advanced/assets.mdx new file mode 100644 index 000000000..84f742b31 --- /dev/null +++ b/website/docs/zh/guide/advanced/assets.mdx @@ -0,0 +1 @@ +# 静态资源处理 diff --git a/website/docs/zh/guide/advanced/css.mdx b/website/docs/zh/guide/advanced/css.mdx new file mode 100644 index 000000000..57156071b --- /dev/null +++ b/website/docs/zh/guide/advanced/css.mdx @@ -0,0 +1 @@ +# 样式处理 diff --git a/website/docs/zh/guide/advanced/dts.mdx b/website/docs/zh/guide/advanced/dts.mdx new file mode 100644 index 000000000..889b94684 --- /dev/null +++ b/website/docs/zh/guide/advanced/dts.mdx @@ -0,0 +1 @@ +# 类型生成 diff --git a/website/docs/zh/guide/advanced/module-doc.mdx b/website/docs/zh/guide/advanced/module-doc.mdx new file mode 100644 index 000000000..078d547fa --- /dev/null +++ b/website/docs/zh/guide/advanced/module-doc.mdx @@ -0,0 +1 @@ +# 开发模块文档 diff --git a/website/docs/zh/guide/advanced/monorepo.mdx b/website/docs/zh/guide/advanced/monorepo.mdx new file mode 100644 index 000000000..a16fc45d2 --- /dev/null +++ b/website/docs/zh/guide/advanced/monorepo.mdx @@ -0,0 +1 @@ +# Monorepo 开发 diff --git a/website/docs/zh/guide/advanced/package-json.mdx b/website/docs/zh/guide/advanced/package-json.mdx new file mode 100644 index 000000000..262122676 --- /dev/null +++ b/website/docs/zh/guide/advanced/package-json.mdx @@ -0,0 +1 @@ +# 编写 package.json diff --git a/website/docs/zh/guide/advanced/polyfill.mdx b/website/docs/zh/guide/advanced/polyfill.mdx new file mode 100644 index 000000000..ff8da85b0 --- /dev/null +++ b/website/docs/zh/guide/advanced/polyfill.mdx @@ -0,0 +1 @@ +# 目标环境与兼容性 diff --git a/website/docs/zh/guide/advanced/storybook.mdx b/website/docs/zh/guide/advanced/storybook.mdx new file mode 100644 index 000000000..9c1dcefb1 --- /dev/null +++ b/website/docs/zh/guide/advanced/storybook.mdx @@ -0,0 +1 @@ +# 使用 storybook diff --git a/website/docs/zh/guide/advanced/templates.mdx b/website/docs/zh/guide/advanced/templates.mdx new file mode 100644 index 000000000..f81040e3a --- /dev/null +++ b/website/docs/zh/guide/advanced/templates.mdx @@ -0,0 +1 @@ +# 模板与预设 diff --git a/website/docs/zh/guide/advanced/third-party-deps.mdx b/website/docs/zh/guide/advanced/third-party-deps.mdx new file mode 100644 index 000000000..2bbe06724 --- /dev/null +++ b/website/docs/zh/guide/advanced/third-party-deps.mdx @@ -0,0 +1 @@ +# 三方依赖处理 diff --git a/website/docs/zh/guide/basic/_meta.json b/website/docs/zh/guide/basic/_meta.json index df3df9223..8d965b8e1 100644 --- a/website/docs/zh/guide/basic/_meta.json +++ b/website/docs/zh/guide/basic/_meta.json @@ -1 +1,11 @@ -["configure-rslib"] +[ + "cli", + "configure-rslib", + "configure-rsbuild-rspack", + "typescript-usage", + "output-files", + "bundle-mode", + "upgrade-rslib", + "cjs-esm", + "umd" +] diff --git a/website/docs/zh/guide/basic/bundle-mode.mdx b/website/docs/zh/guide/basic/bundle-mode.mdx new file mode 100644 index 000000000..afe2b441e --- /dev/null +++ b/website/docs/zh/guide/basic/bundle-mode.mdx @@ -0,0 +1 @@ +# 构建模式选择 diff --git a/website/docs/zh/guide/basic/cjs-esm.mdx b/website/docs/zh/guide/basic/cjs-esm.mdx new file mode 100644 index 000000000..617eb1d3d --- /dev/null +++ b/website/docs/zh/guide/basic/cjs-esm.mdx @@ -0,0 +1 @@ +# CJS 与 ESM diff --git a/website/docs/zh/guide/basic/cli.mdx b/website/docs/zh/guide/basic/cli.mdx new file mode 100644 index 000000000..80898d198 --- /dev/null +++ b/website/docs/zh/guide/basic/cli.mdx @@ -0,0 +1 @@ +# 命令行工具 diff --git a/website/docs/zh/guide/basic/configure-rsbuild-rspack.mdx b/website/docs/zh/guide/basic/configure-rsbuild-rspack.mdx new file mode 100644 index 000000000..38b72c76e --- /dev/null +++ b/website/docs/zh/guide/basic/configure-rsbuild-rspack.mdx @@ -0,0 +1 @@ +# 配置 Rsbuild / Rspack diff --git a/website/docs/zh/guide/basic/output-files.mdx b/website/docs/zh/guide/basic/output-files.mdx new file mode 100644 index 000000000..df554c14d --- /dev/null +++ b/website/docs/zh/guide/basic/output-files.mdx @@ -0,0 +1 @@ +# 构建产物目录 diff --git a/website/docs/zh/guide/basic/typescript-usage.mdx b/website/docs/zh/guide/basic/typescript-usage.mdx new file mode 100644 index 000000000..8b199f180 --- /dev/null +++ b/website/docs/zh/guide/basic/typescript-usage.mdx @@ -0,0 +1 @@ +# 使用 Typescript diff --git a/website/docs/zh/guide/basic/umd.mdx b/website/docs/zh/guide/basic/umd.mdx new file mode 100644 index 000000000..e78e68987 --- /dev/null +++ b/website/docs/zh/guide/basic/umd.mdx @@ -0,0 +1 @@ +# UMD diff --git a/website/docs/zh/guide/basic/upgrade-rslib.mdx b/website/docs/zh/guide/basic/upgrade-rslib.mdx new file mode 100644 index 000000000..3c34eec28 --- /dev/null +++ b/website/docs/zh/guide/basic/upgrade-rslib.mdx @@ -0,0 +1 @@ +# 升级 Rslib diff --git a/website/docs/zh/guide/debug/_meta.json b/website/docs/zh/guide/debug/_meta.json new file mode 100644 index 000000000..5ec4cb842 --- /dev/null +++ b/website/docs/zh/guide/debug/_meta.json @@ -0,0 +1 @@ +["debug-mode", "build-profiling", "rsdoctor"] diff --git a/website/docs/zh/guide/debug/build-profiling.mdx b/website/docs/zh/guide/debug/build-profiling.mdx new file mode 100644 index 000000000..c940403c5 --- /dev/null +++ b/website/docs/zh/guide/debug/build-profiling.mdx @@ -0,0 +1 @@ +# 构建性能分析 diff --git a/website/docs/zh/guide/debug/debug-mode.mdx b/website/docs/zh/guide/debug/debug-mode.mdx new file mode 100644 index 000000000..8950a77b5 --- /dev/null +++ b/website/docs/zh/guide/debug/debug-mode.mdx @@ -0,0 +1 @@ +# 开启调试模式 diff --git a/website/docs/zh/guide/debug/rsdoctor.mdx b/website/docs/zh/guide/debug/rsdoctor.mdx new file mode 100644 index 000000000..f62c1ff16 --- /dev/null +++ b/website/docs/zh/guide/debug/rsdoctor.mdx @@ -0,0 +1 @@ +# 使用 Rsdoctor diff --git a/website/docs/zh/guide/faq/_meta.json b/website/docs/zh/guide/faq/_meta.json new file mode 100644 index 000000000..7e1ef5ec4 --- /dev/null +++ b/website/docs/zh/guide/faq/_meta.json @@ -0,0 +1 @@ +["general", "features", "exceptions"] diff --git a/website/docs/zh/guide/faq/exceptions.mdx b/website/docs/zh/guide/faq/exceptions.mdx new file mode 100644 index 000000000..a1263cb27 --- /dev/null +++ b/website/docs/zh/guide/faq/exceptions.mdx @@ -0,0 +1 @@ +# 异常类问题 diff --git a/website/docs/zh/guide/faq/features.mdx b/website/docs/zh/guide/faq/features.mdx new file mode 100644 index 000000000..894d595ae --- /dev/null +++ b/website/docs/zh/guide/faq/features.mdx @@ -0,0 +1 @@ +# 功能类问题 diff --git a/website/docs/zh/guide/faq/general.mdx b/website/docs/zh/guide/faq/general.mdx new file mode 100644 index 000000000..a4ae1f104 --- /dev/null +++ b/website/docs/zh/guide/faq/general.mdx @@ -0,0 +1 @@ +# 通用类问题 diff --git a/website/docs/zh/guide/framework/_meta.json b/website/docs/zh/guide/framework/_meta.json new file mode 100644 index 000000000..d68a725ef --- /dev/null +++ b/website/docs/zh/guide/framework/_meta.json @@ -0,0 +1 @@ +["typescript", "react", "vue"] diff --git a/website/docs/zh/guide/framework/react.mdx b/website/docs/zh/guide/framework/react.mdx new file mode 100644 index 000000000..4a55d1124 --- /dev/null +++ b/website/docs/zh/guide/framework/react.mdx @@ -0,0 +1 @@ +# React diff --git a/website/docs/zh/guide/framework/typescript.mdx b/website/docs/zh/guide/framework/typescript.mdx new file mode 100644 index 000000000..42c977580 --- /dev/null +++ b/website/docs/zh/guide/framework/typescript.mdx @@ -0,0 +1 @@ +# Typescript diff --git a/website/docs/zh/guide/framework/vue.mdx b/website/docs/zh/guide/framework/vue.mdx new file mode 100644 index 000000000..9d38c2e9d --- /dev/null +++ b/website/docs/zh/guide/framework/vue.mdx @@ -0,0 +1 @@ +# Vue diff --git a/website/docs/zh/guide/migration/_meta.json b/website/docs/zh/guide/migration/_meta.json new file mode 100644 index 000000000..6f21679f2 --- /dev/null +++ b/website/docs/zh/guide/migration/_meta.json @@ -0,0 +1 @@ +["modernjs-module", "tsup", "rollup", "esbuild"] diff --git a/website/docs/zh/guide/migration/esbuild.mdx b/website/docs/zh/guide/migration/esbuild.mdx new file mode 100644 index 000000000..1d625c5a9 --- /dev/null +++ b/website/docs/zh/guide/migration/esbuild.mdx @@ -0,0 +1 @@ +# esbuild diff --git a/website/docs/zh/guide/migration/modernjs-module.mdx b/website/docs/zh/guide/migration/modernjs-module.mdx new file mode 100644 index 000000000..e435abd7f --- /dev/null +++ b/website/docs/zh/guide/migration/modernjs-module.mdx @@ -0,0 +1 @@ +# Modern.js Module diff --git a/website/docs/zh/guide/migration/rollup.mdx b/website/docs/zh/guide/migration/rollup.mdx new file mode 100644 index 000000000..37db6ad52 --- /dev/null +++ b/website/docs/zh/guide/migration/rollup.mdx @@ -0,0 +1 @@ +# rollup diff --git a/website/docs/zh/guide/migration/tsup.mdx b/website/docs/zh/guide/migration/tsup.mdx new file mode 100644 index 000000000..d514e9899 --- /dev/null +++ b/website/docs/zh/guide/migration/tsup.mdx @@ -0,0 +1 @@ +# tsup diff --git a/website/docs/zh/guide/start/_meta.json b/website/docs/zh/guide/start/_meta.json index 8a5be8c86..e2cb04931 100644 --- a/website/docs/zh/guide/start/_meta.json +++ b/website/docs/zh/guide/start/_meta.json @@ -1 +1 @@ -["index", "quick-start", "features"] +["index", "quick-start", "features", "glossary", "npm-packages"] diff --git a/website/docs/zh/guide/start/glossary.mdx b/website/docs/zh/guide/start/glossary.mdx new file mode 100644 index 000000000..b8909dd6c --- /dev/null +++ b/website/docs/zh/guide/start/glossary.mdx @@ -0,0 +1 @@ +# 术语表 diff --git a/website/docs/zh/guide/start/npm-packages.mdx b/website/docs/zh/guide/start/npm-packages.mdx new file mode 100644 index 000000000..26c41a74c --- /dev/null +++ b/website/docs/zh/guide/start/npm-packages.mdx @@ -0,0 +1 @@ +# npm 包 diff --git a/website/rspress.config.ts b/website/rspress.config.ts index a3720dadc..797c7a288 100644 --- a/website/rspress.config.ts +++ b/website/rspress.config.ts @@ -9,11 +9,9 @@ export default defineConfig({ lang: 'en', base: '/', title: 'Rslib', - icon: 'https://assets.rspack.dev/rslib/rslib-logo.png', - logo: { - light: 'https://assets.rspack.dev/rslib/rslib-logo.png', - dark: 'https://assets.rspack.dev/rslib/rslib-logo.png', - }, + icon: 'https://assets.rspack.dev/rslib/rslib-logo-192x192.png', + logo: 'https://assets.rspack.dev/rslib/rslib-logo-192x192.png', + logoText: 'Rslib', ssg: { strict: true, }, @@ -65,6 +63,9 @@ export default defineConfig({ outlineTitle: '目录', prevPageText: '上一页', nextPageText: '下一页', + searchPlaceholderText: '搜索文档', + searchNoResultsText: '无法找到相关搜索结果', + searchSuggestedQueryText: '请使用不同的关键字重试', description: '基于 Rsbuild 的库构建工具', editLink: { docRepoBaseUrl: diff --git a/website/theme/index.tsx b/website/theme/index.tsx index e8473c5e2..c310300de 100644 --- a/website/theme/index.tsx +++ b/website/theme/index.tsx @@ -1,9 +1,35 @@ +import { Announcement } from '@rstack-dev/doc-ui/announcement'; import { NavIcon } from '@rstack-dev/doc-ui/nav-icon'; +import { NoSSR, useLang, usePageData } from 'rspress/runtime'; import Theme from 'rspress/theme'; import { HomeLayout } from './pages'; import './index.scss'; -const Layout = () => } />; +const ANNOUNCEMENT_URL = '/'; + +const Layout = () => { + const { page } = usePageData(); + const lang = useLang(); + return ( + } + beforeNav={ + + + + } + /> + ); +}; export default { ...Theme,