From 9da972dc44c21cf0e337f1c3fca44eb9df3e40d5 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Wed, 25 Nov 2020 17:18:49 -0500 Subject: docs: npm star cleanup Fix: https://github.com/npm/statusboard/issues/245 Fix: https://github.com/npm/statusboard/issues/246 PR-URL: https://github.com/npm/cli/pull/2241 Credit: @ruyadorno Close: #2241 Reviewed-by: @darcyclarke --- docs/content/commands/npm-star.md | 17 +++++++++++++++-- docs/content/commands/npm-stars.md | 1 + docs/content/commands/npm-unstar.md | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 docs/content/commands/npm-unstar.md (limited to 'docs/content') diff --git a/docs/content/commands/npm-star.md b/docs/content/commands/npm-star.md index c68a057aa..aab6e1077 100644 --- a/docs/content/commands/npm-star.md +++ b/docs/content/commands/npm-star.md @@ -8,7 +8,6 @@ description: Mark your favorite packages ```bash npm star [...] -npm unstar [...] ``` ### Description @@ -16,12 +15,26 @@ npm unstar [...] "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) diff --git a/docs/content/commands/npm-stars.md b/docs/content/commands/npm-stars.md index 706134398..dab11bc66 100644 --- a/docs/content/commands/npm-stars.md +++ b/docs/content/commands/npm-stars.md @@ -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) diff --git a/docs/content/commands/npm-unstar.md b/docs/content/commands/npm-unstar.md new file mode 100644 index 000000000..5471d9080 --- /dev/null +++ b/docs/content/commands/npm-unstar.md @@ -0,0 +1,37 @@ +--- +title: npm-unstar +section: 1 +description: Remove an item from your favorite packages +--- + +### Synopsis + +```bash +npm unstar [...] +``` + +### 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) + -- cgit v1.2.3