Skip to content

Commit

Permalink
docs: change api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgao365 committed Jul 1, 2024
1 parent 7ae2010 commit ff84edd
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @tomjs/vite-plugin-html

[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-html)](https://www.npmjs.com/package/@tomjs/vite-plugin-html) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-html) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-html) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/@tomjs/vite-plugin-html)
[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-html)](https://www.npmjs.com/package/@tomjs/vite-plugin-html) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-html) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-html) [![Docs](https://img.shields.io/badge/API-unpkg-orange)](https://www.unpkg.com/browse/@tomjs/vite-plugin-html/dist/index.d.ts)

**English** | [中文](./README.zh_CN.md)

Expand All @@ -23,7 +23,7 @@ yarn add @tomjs/vite-plugin-html -D
With `npm`

```bash
npm i @tomjs/vite-plugin-html --save-dev
npm add @tomjs/vite-plugin-html -D
```

## Usage
Expand Down Expand Up @@ -82,7 +82,6 @@ export default defineConfig({

#### Documentation

- [API Documentation](https://paka.dev/npm/@tomjs/vite-plugin-html) provided by [paka.dev](https://paka.dev).
- [index.d.ts](https://www.unpkg.com/browse/@tomjs/vite-plugin-html/dist/index.d.ts) provided by [unpkg.com](https://www.unpkg.com).

#### Parameters
Expand Down
5 changes: 2 additions & 3 deletions README.zh_CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @tomjs/vite-plugin-html

[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-html)](https://www.npmjs.com/package/@tomjs/vite-plugin-html) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-html) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-html) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/@tomjs/vite-plugin-html)
[![npm](https://img.shields.io/npm/v/@tomjs/vite-plugin-html)](https://www.npmjs.com/package/@tomjs/vite-plugin-html) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vite-plugin-html) ![NPM](https://img.shields.io/npm/l/@tomjs/vite-plugin-html) [![Docs](https://img.shields.io/badge/API-unpkg-orange)](https://www.unpkg.com/browse/@tomjs/vite-plugin-html/dist/index.d.ts)

[English](./README.md) | **中文**

Expand All @@ -23,7 +23,7 @@ yarn add @tomjs/vite-plugin-html -D
使用 `npm`

```bash
npm i @tomjs/vite-plugin-html --save-dev
npm add @tomjs/vite-plugin-html -D
```

## 使用说明
Expand Down Expand Up @@ -82,7 +82,6 @@ export default defineConfig({

#### 文档

- [paka.dev](https://paka.dev) 提供的 [API文档](https://paka.dev/npm/@tomjs/vite-plugin-html).
- [unpkg.com](https://www.unpkg.com/) 提供的 [index.d.ts](https://www.unpkg.com/browse/@tomjs/vite-plugin-html/dist/index.d.ts).

#### 参数
Expand Down
12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,13 @@
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"require": "./dist/index.js",
"import": "./dist/index.mjs",
"require": {
"default": "./dist/index.js",
"types": "./dist/index.d.ts"
},
"import": {
"default": "./dist/index.mjs",
"types": "./dist/index.d.mts"
}
},
"scripts": {
Expand Down Expand Up @@ -87,5 +90,6 @@
"tsx": "^4.7.0",
"typescript": "~5.3.3",
"vite": "^5.0.10"
}
},
"packageManager": "[email protected]"
}

0 comments on commit ff84edd

Please sign in to comment.