Skip to content

Commit 9da972d

Browse files
committed
docs: npm star cleanup
Fix: npm/statusboard#245 Fix: npm/statusboard#246 PR-URL: #2241 Credit: @ruyadorno Close: #2241 Reviewed-by: @darcyclarke
1 parent 67cef80 commit 9da972d

File tree

3 files changed

+53
-2
lines changed

3 files changed

+53
-2
lines changed

docs/content/commands/npm-star.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,33 @@ description: Mark your favorite packages
88

99
```bash
1010
npm star [<pkg>...]
11-
npm unstar [<pkg>...]
1211
```
1312

1413
### Description
1514

1615
"Starring" a package means that you have some interest in it. It's
1716
a vaguely positive way to show that you care.
1817

18+
It's a boolean thing. Starring repeatedly has no additional effect.
19+
20+
### More
21+
22+
There's also these extra commands to help you manage your favorite packages:
23+
24+
#### Unstar
25+
26+
You can also "unstar" a package using [`npm unstar`](/commands/npm-unstar)
27+
1928
"Unstarring" is the same thing, but in reverse.
2029

21-
It's a boolean thing. Starring repeatedly has no additional effect.
30+
#### Listing stars
31+
32+
You can see all your starred packages using [`npm stars`](/commands/npm-stars)
2233

2334
### See Also
2435

36+
* [npm unstar](/commands/npm-unstar)
37+
* [npm stars](/commands/npm-stars)
2538
* [npm view](/commands/npm-view)
2639
* [npm whoami](/commands/npm-whoami)
2740
* [npm adduser](/commands/npm-adduser)

docs/content/commands/npm-stars.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ you will most certainly enjoy this command.
2020
### See Also
2121

2222
* [npm star](/commands/npm-star)
23+
* [npm unstar](/commands/npm-unstar)
2324
* [npm view](/commands/npm-view)
2425
* [npm whoami](/commands/npm-whoami)
2526
* [npm adduser](/commands/npm-adduser)

docs/content/commands/npm-unstar.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: npm-unstar
3+
section: 1
4+
description: Remove an item from your favorite packages
5+
---
6+
7+
### Synopsis
8+
9+
```bash
10+
npm unstar [<pkg>...]
11+
```
12+
13+
### Description
14+
15+
"Unstarring" a package is the opposite of [`npm star`](/commands/npm-star),
16+
it removes an item from your list of favorite packages.
17+
18+
### More
19+
20+
There's also these extra commands to help you manage your favorite packages:
21+
22+
#### Star
23+
24+
You can "star" a package using [`npm star`](/commands/npm-star)
25+
26+
#### Listing stars
27+
28+
You can see all your starred packages using [`npm stars`](/commands/npm-stars)
29+
30+
### See Also
31+
32+
* [npm star](/commands/npm-star)
33+
* [npm stars](/commands/npm-stars)
34+
* [npm view](/commands/npm-view)
35+
* [npm whoami](/commands/npm-whoami)
36+
* [npm adduser](/commands/npm-adduser)
37+

0 commit comments

Comments
 (0)