Skip to content

docs: init website structure #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions website/docs/en/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
}
]
7 changes: 7 additions & 0 deletions website/docs/en/api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"type": "dir",
"name": "javascript-api",
"label": "JavaScript API"
}
]
1 change: 1 addition & 0 deletions website/docs/en/api/javascript-api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["core", "types"]
1 change: 1 addition & 0 deletions website/docs/en/api/javascript-api/core.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rslib Core
1 change: 1 addition & 0 deletions website/docs/en/api/javascript-api/types.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rslib Types
1 change: 1 addition & 0 deletions website/docs/en/blog/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["index"]
7 changes: 7 additions & 0 deletions website/docs/en/blog/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
---

# Rslib Blogs

Check here for the latest articles and release announcements about Rslib.
9 changes: 7 additions & 2 deletions website/docs/en/config/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
7 changes: 5 additions & 2 deletions website/docs/en/config/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions website/docs/en/config/lib.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Lib
14 changes: 14 additions & 0 deletions website/docs/en/config/lib/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[
"bundle",
"format",
"auto-extension",
"auto-external",
"redirect",
"syntax",
"external-helpers",
"banner",
"footer",
"dts",
"shims",
"umd-name"
]
1 change: 1 addition & 0 deletions website/docs/en/config/lib/auto-extension.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.autoExtension
1 change: 1 addition & 0 deletions website/docs/en/config/lib/auto-external.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.autoExternal
1 change: 1 addition & 0 deletions website/docs/en/config/lib/banner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.banner
1 change: 1 addition & 0 deletions website/docs/en/config/lib/bundle.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.bundle
1 change: 1 addition & 0 deletions website/docs/en/config/lib/dts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.dts
1 change: 1 addition & 0 deletions website/docs/en/config/lib/external-helpers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.externalHelpers
1 change: 1 addition & 0 deletions website/docs/en/config/lib/footer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.footer
1 change: 1 addition & 0 deletions website/docs/en/config/lib/format.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.format
1 change: 1 addition & 0 deletions website/docs/en/config/lib/redirect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.redirect
4 changes: 4 additions & 0 deletions website/docs/en/config/lib/shims.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
overviewHeaders: [2, 3]
---

# lib.shims

- **Type:**
Expand Down
1 change: 1 addition & 0 deletions website/docs/en/config/lib/syntax.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.syntax
1 change: 1 addition & 0 deletions website/docs/en/config/lib/umd-name.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.umdName
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rsbuild 配置
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["plugins", "source", "output", "tools"]
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild/output.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# output
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild/plugins.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# plugins
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild/source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# source
1 change: 1 addition & 0 deletions website/docs/en/config/rsbuild/tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# tools
15 changes: 15 additions & 0 deletions website/docs/en/guide/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
14 changes: 13 additions & 1 deletion website/docs/en/guide/advanced/_meta.json
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
["module-federation"]
[
"package-json",
"templates",
"third-party-deps",
"polyfill",
"css",
"assets",
"dts",
"module-federation",
"module-doc",
"storybook",
"monorepo"
]
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/assets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Assets
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/css.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CSS
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/dts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# DTS
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/module-doc.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Module Doc
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/monorepo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Monorepo
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/package-json.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Write package.json
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/polyfill.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Target and Polyfill
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/storybook.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use Storybook
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/templates.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Templates
1 change: 1 addition & 0 deletions website/docs/en/guide/advanced/third-party-deps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Handle Third-party Dependencies
12 changes: 11 additions & 1 deletion website/docs/en/guide/basic/_meta.json
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
["configure-rslib", "UMD"]
[
"cli",
"configure-rslib",
"configure-rsbuild-rspack",
"typescript-usage",
"output-files",
"bundle-mode",
"upgrade-rslib",
"cjs-esm",
"umd"
]
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/bundle-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Select Bundle Mode
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/cjs-esm.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CJS and ESM
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CLI
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/configure-rsbuild-rspack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configure Rsbuild / Rspack
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/output-files.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Output Files
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/typescript-usage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use Typescript
1 change: 1 addition & 0 deletions website/docs/en/guide/basic/upgrade-rslib.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Upgrade Rslib
1 change: 1 addition & 0 deletions website/docs/en/guide/debug/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["debug-mode", "build-profiling", "rsdoctor"]
1 change: 1 addition & 0 deletions website/docs/en/guide/debug/build-profiling.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Build Profiling
1 change: 1 addition & 0 deletions website/docs/en/guide/debug/debug-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Debug Mode
1 change: 1 addition & 0 deletions website/docs/en/guide/debug/rsdoctor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Use Rsdoctor
1 change: 1 addition & 0 deletions website/docs/en/guide/faq/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["general", "features", "exceptions"]
1 change: 1 addition & 0 deletions website/docs/en/guide/faq/exceptions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Exceptions FAQ
1 change: 1 addition & 0 deletions website/docs/en/guide/faq/features.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Features FAQ
1 change: 1 addition & 0 deletions website/docs/en/guide/faq/general.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# General FAQ
1 change: 1 addition & 0 deletions website/docs/en/guide/framework/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["typescript", "react", "vue"]
1 change: 1 addition & 0 deletions website/docs/en/guide/framework/react.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# React
1 change: 1 addition & 0 deletions website/docs/en/guide/framework/typescript.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Typescript
1 change: 1 addition & 0 deletions website/docs/en/guide/framework/vue.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Vue
1 change: 1 addition & 0 deletions website/docs/en/guide/migration/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["modernjs-module", "tsup", "rollup", "esbuild"]
1 change: 1 addition & 0 deletions website/docs/en/guide/migration/esbuild.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# esbuild
1 change: 1 addition & 0 deletions website/docs/en/guide/migration/modernjs-module.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Modern.js Module
1 change: 1 addition & 0 deletions website/docs/en/guide/migration/rollup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# rollup
1 change: 1 addition & 0 deletions website/docs/en/guide/migration/tsup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# tsup
2 changes: 1 addition & 1 deletion website/docs/en/guide/start/_meta.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["index", "quick-start", "features"]
["index", "quick-start", "features", "glossary", "npm-packages"]
1 change: 1 addition & 0 deletions website/docs/en/guide/start/glossary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Glossary
1 change: 1 addition & 0 deletions website/docs/en/guide/start/npm-packages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Packages
15 changes: 15 additions & 0 deletions website/docs/zh/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
}
]
7 changes: 7 additions & 0 deletions website/docs/zh/api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"type": "dir",
"name": "javascript-api",
"label": "JavaScript API"
}
]
1 change: 1 addition & 0 deletions website/docs/zh/api/javascript-api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["core", "types"]
1 change: 1 addition & 0 deletions website/docs/zh/api/javascript-api/core.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rslib Core
1 change: 1 addition & 0 deletions website/docs/zh/api/javascript-api/types.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rslib Types
1 change: 1 addition & 0 deletions website/docs/zh/blog/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["index"]
7 changes: 7 additions & 0 deletions website/docs/zh/blog/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 总览
---

# Rslib 博客

在此查看有关 Rslib 的最新文章和发布公告。
17 changes: 17 additions & 0 deletions website/docs/zh/config/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"type": "file",
"name": "index",
"label": "配置总览"
},
{
"type": "dir",
"name": "lib",
"label": "Lib"
},
{
"type": "dir",
"name": "rsbuild",
"label": "Rsbuild 配置"
}
]
6 changes: 6 additions & 0 deletions website/docs/zh/config/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
overview: true
title: 配置总览
---

本页列出了 Rslib 的所有配置。有关详细信息,请参阅 [配置 Rslib](/guide/basic/configure-rslib)。
1 change: 1 addition & 0 deletions website/docs/zh/config/lib.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Lib
14 changes: 14 additions & 0 deletions website/docs/zh/config/lib/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[
"bundle",
"format",
"auto-extension",
"auto-external",
"redirect",
"syntax",
"external-helpers",
"banner",
"footer",
"dts",
"shims",
"umd-name"
]
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/auto-extension.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.autoExtension
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/auto-external.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.autoExternal
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/banner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.banner
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/bundle.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.bundle
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/dts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.dts
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/external-helpers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.externalHelpers
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/footer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.footer
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/format.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.format
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/redirect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.redirect
5 changes: 5 additions & 0 deletions website/docs/zh/config/lib/shims.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
overviewHeaders: [2, 3]
---

# lib.shims
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/syntax.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.syntax
1 change: 1 addition & 0 deletions website/docs/zh/config/lib/umd-name.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# lib.umdName
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Rsbuild 配置
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["plugins", "source", "output", "tools"]
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild/output.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# output
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild/plugins.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# plugins
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild/source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# source
1 change: 1 addition & 0 deletions website/docs/zh/config/rsbuild/tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# tools
Loading
Loading