Skip to content

Commit d276a83

Browse files
committed
feat(website): update docusaurus config
1 parent 128e07e commit d276a83

File tree

5 files changed

+150
-211
lines changed

5 files changed

+150
-211
lines changed

apps/website/docs/guide/01-installation.mdx

Lines changed: 6 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -35,57 +35,17 @@ import TabItem from '@theme/TabItem';
3535

3636
To install CommandKit, run one of the following commands based on your preferred package manager:
3737

38-
<Tabs>
39-
<TabItem value='npm' label='npm'>
40-
```
41-
npm install commandkit
42-
```
43-
</TabItem>
44-
<TabItem value='yarn' label='yarn'>
45-
```
46-
yarn add commandkit
47-
```
48-
</TabItem>
49-
<TabItem value='pnpm' label='pnpm'>
50-
```
51-
pnpm install commandkit
52-
```
53-
</TabItem>
54-
<TabItem value='bun' label='bun'>
55-
```
56-
bun install commandkit
57-
```
58-
</TabItem>
59-
60-
</Tabs>
38+
```bash npm2yarn
39+
npm install commandkit
40+
```
6141

6242
## Development version
6343

6444
To install the development version of CommandKit, run one of the following commands:
6545

66-
<Tabs>
67-
<TabItem value='npm' label='npm'>
68-
```
69-
npm install commandkit@dev
70-
```
71-
</TabItem>
72-
<TabItem value='yarn' label='yarn'>
73-
```
74-
yarn add commandkit@dev
75-
```
76-
</TabItem>
77-
<TabItem value='pnpm' label='pnpm'>
78-
```
79-
pnpm install commandkit@dev
80-
```
81-
</TabItem>
82-
<TabItem value='bun' label='bun'>
83-
```
84-
bun install commandkit@dev
85-
```
86-
</TabItem>
87-
88-
</Tabs>
46+
```bash npm2yarn
47+
npm install commandkit@dev
48+
```
8949

9050
:::warning
9151
The development version is likely to have bugs.

apps/website/docs/guide/02-create-commandkit.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Besides installing CommandKit to your existing project, you can also start a new
1111

1212
If you want to create a new CommandKit application, simply run the following command:
1313

14-
```
14+
```bash
1515
npm create commandkit@latest
1616
```
1717

@@ -25,7 +25,7 @@ Similar to the main package, you could try the `dev` version of create-commandki
2525
The development version is likely to have bugs.
2626
:::
2727

28-
```
28+
```bash
2929
npm create commandkit@dev
3030
```
3131

apps/website/docusaurus.config.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ const config: Config = {
2020
{
2121
docs: {
2222
sidebarPath: './sidebars.ts',
23+
showLastUpdateAuthor: true,
24+
showLastUpdateTime: true,
25+
remarkPlugins: [
26+
[require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }],
27+
],
2328
editUrl:
2429
'https://github.com/underctrl-io/commandkit/tree/main/apps/website/',
2530
},

apps/website/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
7-
"start": "docusaurus start",
7+
"dev": "docusaurus start",
88
"build": "docusaurus build",
99
"swizzle": "docusaurus swizzle",
1010
"deploy": "docusaurus deploy",
@@ -25,6 +25,7 @@
2525
},
2626
"devDependencies": {
2727
"@docusaurus/module-type-aliases": "3.6.3",
28+
"@docusaurus/remark-plugin-npm2yarn": "^3.6.3",
2829
"@docusaurus/tsconfig": "3.6.3",
2930
"@docusaurus/types": "3.6.3",
3031
"typescript": "~5.6.2"

0 commit comments

Comments
 (0)