Skip to content

Commit

Permalink
docs: npm star cleanup
Browse files Browse the repository at this point in the history
Fix: npm/statusboard#245
Fix: npm/statusboard#246

PR-URL: #2241
Credit: @ruyadorno
Close: #2241
Reviewed-by: @darcyclarke
  • Loading branch information
ruyadorno committed Nov 27, 2020
1 parent 67cef80 commit 9da972d
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/content/commands/npm-star.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,33 @@ description: Mark your favorite packages

```bash
npm star [<pkg>...]
npm unstar [<pkg>...]
```

### Description

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

It's a boolean thing. Starring repeatedly has no additional effect.

### More

There's also these extra commands to help you manage your favorite packages:

#### Unstar

You can also "unstar" a package using [`npm unstar`](/commands/npm-unstar)

"Unstarring" is the same thing, but in reverse.

It's a boolean thing. Starring repeatedly has no additional effect.
#### Listing stars

You can see all your starred packages using [`npm stars`](/commands/npm-stars)

### See Also

* [npm unstar](/commands/npm-unstar)
* [npm stars](/commands/npm-stars)
* [npm view](/commands/npm-view)
* [npm whoami](/commands/npm-whoami)
* [npm adduser](/commands/npm-adduser)
1 change: 1 addition & 0 deletions docs/content/commands/npm-stars.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ you will most certainly enjoy this command.
### See Also

* [npm star](/commands/npm-star)
* [npm unstar](/commands/npm-unstar)
* [npm view](/commands/npm-view)
* [npm whoami](/commands/npm-whoami)
* [npm adduser](/commands/npm-adduser)
37 changes: 37 additions & 0 deletions docs/content/commands/npm-unstar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: npm-unstar
section: 1
description: Remove an item from your favorite packages
---

### Synopsis

```bash
npm unstar [<pkg>...]
```

### Description

"Unstarring" a package is the opposite of [`npm star`](/commands/npm-star),
it removes an item from your list of favorite packages.

### More

There's also these extra commands to help you manage your favorite packages:

#### Star

You can "star" a package using [`npm star`](/commands/npm-star)

#### Listing stars

You can see all your starred packages using [`npm stars`](/commands/npm-stars)

### See Also

* [npm star](/commands/npm-star)
* [npm stars](/commands/npm-stars)
* [npm view](/commands/npm-view)
* [npm whoami](/commands/npm-whoami)
* [npm adduser](/commands/npm-adduser)

0 comments on commit 9da972d

Please sign in to comment.