Skip to content

Commit 815f060

Browse files
stephl3stephl3
authored
chore(docs): standardize package installation commands and remove HTML output sections (#3051)
* docs: consistent install instructions and no html outputs in READMEs * docs(message-feedback): drop extra PNPM subsection
1 parent 349a97f commit 815f060

File tree

71 files changed

+424
-1061
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+424
-1061
lines changed

‎charts/core/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Library of composable charting components that provides a way to create interact
66

77
## Installation
88

9+
### PNPM
10+
11+
```shell
12+
pnpm add @lg-charts/core
13+
```
14+
915
### Yarn
1016

1117
```shell

‎chat/avatar/README.md‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Please use `Avatar` from `@leafygreen-ui/avatar` instead.
55

66
## Installation
77

8+
### PNPM
9+
10+
```shell
11+
pnpm add @lg-chat/avatar
12+
```
13+
814
### Yarn
915

1016
```shell
@@ -25,25 +31,6 @@ import { Avatar } from '@lg-chat/avatar';
2531
return <Avatar darkMode variant={Variant.Mongo} />;
2632
```
2733

28-
**Output HTML**
29-
30-
```html
31-
<div class="lg-ui-lg-message-avatar-0000">
32-
<div class="leafygreen-ui-i5hsjh" data-testid="mongo-avatar">
33-
<svg
34-
role="img"
35-
aria-label="MongoDB Logo"
36-
class="leafygreen-ui-ebwjgf"
37-
height="40"
38-
viewBox="0 0 15 32"
39-
fill="none"
40-
>
41-
<path />
42-
</svg>
43-
</div>
44-
</div>
45-
```
46-
4734
## Properties
4835

4936
| Prop | Type | Description | Default |

‎chat/chat-disclaimer/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
## Installation
88

9+
### PNPM
10+
11+
```shell
12+
pnpm add @lg-chat/chat-disclaimer
13+
```
14+
915
### Yarn
1016

1117
```shell

‎chat/fixed-chat-window/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
## Installation
88

9+
### PNPM
10+
11+
```shell
12+
pnpm add @lg-chat/fixed-chat-window
13+
```
14+
915
### Yarn
1016

1117
```shell

‎chat/lg-markdown/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## Installation
44

5+
### PNPM
6+
7+
```shell
8+
pnpm add @lg-chat/lg-markdown
9+
```
10+
511
### Yarn
612

713
```shell

‎chat/message-feedback/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
### PNPM
88

99
```shell
10-
pnpm install @lg-chat/message-feedback
10+
pnpm add @lg-chat/message-feedback
1111
```
1212

1313
### Yarn

‎chat/message-prompts/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
## Installation
88

9+
### PNPM
10+
11+
```shell
12+
pnpm add @lg-chat/message-prompts
13+
```
14+
915
### Yarn
1016

1117
```shell

‎chat/rich-links/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
## Installation
88

9+
### PNPM
10+
11+
```shell
12+
pnpm add @lg-chat/rich-links
13+
```
14+
915
### Yarn
1016

1117
```shell

‎chat/title-bar/README.md‎

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## Installation
44

5+
### PNPM
6+
7+
```shell
8+
pnpm add @lg-chat/title-bar
9+
```
10+
511
### Yarn
612

713
```shell
@@ -22,36 +28,6 @@ import { TitleBar } from '@lg-chat/title-bar';
2228
return <TitleBar badgeText="Beta" />;
2329
```
2430

25-
**Output HTML**
26-
27-
```html
28-
<div class="leafygreen-ui-3cyua8">
29-
<div class="leafygreen-ui-1l1ozhg">
30-
<div
31-
class="leafygreen-ui-1h06ytl"
32-
data-testid="mongo-avatar"
33-
color="green-base"
34-
>
35-
<svg
36-
role="img"
37-
aria-label="MongoDB Logo"
38-
class="leafygreen-ui-ebwjgf"
39-
height="40"
40-
viewBox="0 0 15 32"
41-
fill="none"
42-
>
43-
<path
44-
d="M10.2779 3.56801C8.93285 1.97392 7.76219 0.354933 7.52557 0.0186807C7.50066 -0.00622689 7.4633 -0.00622689 7.43839 0.0186807C7.20177 0.354933 6.04357 1.97392 4.69856 3.56801C-6.8461 18.2759 6.51681 28.1891 6.51681 28.1891L6.6289 28.2639C6.72853 29.7957 6.9776 32 6.9776 32H7.47576H7.97391C7.97391 32 8.22298 29.8081 8.32261 28.2639L8.4347 28.1767C8.44715 28.1891 21.8225 18.2759 10.2779 3.56801ZM7.48821 27.9774C7.48821 27.9774 6.89043 27.4668 6.72853 27.2053V27.1804L7.45085 11.1648C7.45085 11.115 7.52557 11.115 7.52557 11.1648L8.24789 27.1804V27.2053C8.08599 27.4668 7.48821 27.9774 7.48821 27.9774Z"
45-
fill="#00ED64"
46-
></path>
47-
</svg>
48-
</div>
49-
<p class="leafygreen-ui-1tb6tuo"><strong>LeafyGreen Chat</strong></p>
50-
<div class="leafygreen-ui-1qtf7xy">Beta</div>
51-
</div>
52-
</div>
53-
```
54-
5531
## Properties
5632

5733
| Prop | Type | Description | Default |

‎packages/a11y/README.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
## Installation
66

7+
### PNPM
8+
9+
```shell
10+
pnpm add @leafygreen-ui/a11y
11+
```
12+
713
### Yarn
814

915
```shell
@@ -31,15 +37,6 @@ const Button = () => {
3137
};
3238
```
3339

34-
**Output HTML**
35-
36-
```html
37-
<button>
38-
<svg role="presentation" aria-hidden="true" />
39-
<div>Click me</div>
40-
</button>
41-
```
42-
4340
## VisuallyHidden
4441

4542
### Properties

0 commit comments

Comments
 (0)