Skip to content

Commit 9cdbaae

Browse files
committed
docS: document devtools
1 parent 525c877 commit 9cdbaae

File tree

2 files changed

+59
-46
lines changed

2 files changed

+59
-46
lines changed

apps/website/docs/guide/06-plugins/official-plugins/04-devtools.mdx

Lines changed: 1 addition & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,4 @@ import TabItem from '@theme/TabItem';
88

99
The DevTools plugin for CommandKit provides a set of tools and utilities to enhance the development experience. It includes features like command inspection, performance monitoring, and debugging tools.
1010

11-
:::warning
12-
This plugin is in early development and may not be fully functional. It is recommended to use it for testing and feedback purposes only.
13-
:::
14-
15-
## Installation
16-
17-
<Tabs>
18-
<TabItem value="npm" label="npm">
19-
20-
```bash
21-
npm install @commandkit/devtools@dev
22-
```
23-
24-
</TabItem>
25-
<TabItem value="yarn" label="yarn">
26-
27-
```bash
28-
yarn add @commandkit/devtools@dev
29-
```
30-
31-
</TabItem>
32-
<TabItem value="pnpm" label="pnpm">
33-
34-
```bash
35-
pnpm add @commandkit/devtools@dev
36-
```
37-
38-
</TabItem>
39-
</Tabs>
40-
41-
## Usage
42-
43-
Add the DevTools plugin to your CommandKit configuration:
44-
45-
```ts
46-
import { defineConfig } from 'commandkit';
47-
import { devtools } from '@commandkit/devtools';
48-
49-
export default defineConfig({
50-
plugins: [devtools()],
51-
});
52-
```
53-
54-
That's it! The DevTools plugin will run in http://localhost:4356 when you start your application with `commandkit dev`.
55-
56-
<img src="/img/devtools.webp" alt="DevTools Web" width="100%" />
11+
Check out the [DevTools Guide](../../12-devtools/01-introduction.mdx) for more details on how to use the DevTools plugin.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: DevTools Plugin
3+
description: The DevTools plugin for CommandKit provides a set of tools and utilities to enhance the development experience. It includes features like command inspection, performance monitoring, and debugging tools.
4+
---
5+
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
9+
The DevTools plugin for CommandKit provides a set of tools and utilities to enhance the development experience. It includes features like command inspection, performance monitoring, and debugging tools.
10+
11+
:::warning
12+
This plugin is in early development and may not be fully functional. It is recommended to use it for testing and feedback purposes only.
13+
:::
14+
15+
## Installation
16+
17+
<Tabs>
18+
<TabItem value="npm" label="npm">
19+
20+
```bash
21+
npm install @commandkit/devtools@dev
22+
```
23+
24+
</TabItem>
25+
<TabItem value="yarn" label="yarn">
26+
27+
```bash
28+
yarn add @commandkit/devtools@dev
29+
```
30+
31+
</TabItem>
32+
<TabItem value="pnpm" label="pnpm">
33+
34+
```bash
35+
pnpm add @commandkit/devtools@dev
36+
```
37+
38+
</TabItem>
39+
</Tabs>
40+
41+
## Usage
42+
43+
Add the DevTools plugin to your CommandKit configuration:
44+
45+
```ts
46+
import { defineConfig } from 'commandkit';
47+
import { devtools } from '@commandkit/devtools';
48+
49+
export default defineConfig({
50+
plugins: [devtools()],
51+
});
52+
```
53+
54+
That's it! The DevTools plugin will run in http://localhost:4356 when you start your application with `commandkit dev`.
55+
56+
### Preview
57+
58+
<img src="/img/devtools.webp" alt="DevTools Web" width="100%" />

0 commit comments

Comments
 (0)