From b7c4d039a3662f1fef12a515d3eed476ec56c2be Mon Sep 17 00:00:00 2001 From: Timeless0911 <1604889533@qq.com> Date: Thu, 24 Oct 2024 20:12:38 +0800 Subject: [PATCH 1/2] docs: add npm packages docs --- packages/plugin-dts/package.json | 2 +- website/docs/en/guide/start/npm-packages.mdx | 29 ++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/packages/plugin-dts/package.json b/packages/plugin-dts/package.json index 8c5717ad6..bbe44cce0 100644 --- a/packages/plugin-dts/package.json +++ b/packages/plugin-dts/package.json @@ -1,7 +1,7 @@ { "name": "rsbuild-plugin-dts", "version": "0.0.14", - "description": "Dts plugin for Rsbuild", + "description": "Rsbuild plugin that provides support for emitting declaration files for Typescript in Rslib", "homepage": "https://lib.rsbuild.dev", "bugs": { "url": "https://github.com/web-infra-dev/rslib/issues" diff --git a/website/docs/en/guide/start/npm-packages.mdx b/website/docs/en/guide/start/npm-packages.mdx index 3fbbc74f7..f2c53391f 100644 --- a/website/docs/en/guide/start/npm-packages.mdx +++ b/website/docs/en/guide/start/npm-packages.mdx @@ -1 +1,30 @@ # Packages + +This document showcases all the npm package information maintained by Rslib team. + +## @rslib/core + +![](https://img.shields.io/npm/v/@rslib/core?style=flat-square&colorA=564341&colorB=F8F5FF) + +Rslib core package that provides CLI commands and build capabilities based on Rsbuild. + +- [npm](https://npmjs.com/package/@rslib/core) +- [Source Code](https://github.com/web-infra-dev/rslib/tree/main/packages/core) + +## rsbuild-plugin-dts + +![](https://img.shields.io/npm/v/rsbuild-plugin-dts?style=flat-square&colorA=564341&colorB=F8F5FF) + +Rsbuild plugin that provides support for emitting declaration files for Typescript in Rslib. + +- [npm](https://npmjs.com/package/rsbuild-plugin-dts) +- [Source Code](https://github.com/web-infra-dev/rslib/tree/main/packages/plugin-dts) + +## create-rslib + +![](https://img.shields.io/npm/v/create-rslib?style=flat-square&colorA=564341&colorB=F8F5FF) + +Used to create a new Rslib project. + +- [npm](https://npmjs.com/package/create-rslib) +- [Source Code](https://github.com/web-infra-dev/rslib/tree/main/packages/create-rslib) From f0198933b676a5778cfe8c55d5ca90c205299660 Mon Sep 17 00:00:00 2001 From: Timeless0911 <1604889533@qq.com> Date: Thu, 24 Oct 2024 20:43:43 +0800 Subject: [PATCH 2/2] chore: update --- packages/plugin-dts/package.json | 2 +- website/docs/en/guide/start/npm-packages.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/plugin-dts/package.json b/packages/plugin-dts/package.json index bbe44cce0..d1ac145e7 100644 --- a/packages/plugin-dts/package.json +++ b/packages/plugin-dts/package.json @@ -1,7 +1,7 @@ { "name": "rsbuild-plugin-dts", "version": "0.0.14", - "description": "Rsbuild plugin that provides support for emitting declaration files for Typescript in Rslib", + "description": "Rsbuild plugin that supports emitting declaration files for TypeScript.", "homepage": "https://lib.rsbuild.dev", "bugs": { "url": "https://github.com/web-infra-dev/rslib/issues" diff --git a/website/docs/en/guide/start/npm-packages.mdx b/website/docs/en/guide/start/npm-packages.mdx index f2c53391f..60e9d7198 100644 --- a/website/docs/en/guide/start/npm-packages.mdx +++ b/website/docs/en/guide/start/npm-packages.mdx @@ -15,7 +15,7 @@ Rslib core package that provides CLI commands and build capabilities based on Rs ![](https://img.shields.io/npm/v/rsbuild-plugin-dts?style=flat-square&colorA=564341&colorB=F8F5FF) -Rsbuild plugin that provides support for emitting declaration files for Typescript in Rslib. +Rsbuild plugin that supports emitting declaration files for TypeScript. - [npm](https://npmjs.com/package/rsbuild-plugin-dts) - [Source Code](https://github.com/web-infra-dev/rslib/tree/main/packages/plugin-dts)