Skip to content

Commit

Permalink
docs: Improve manpage section for package.json funding properties (
Browse files Browse the repository at this point in the history
…#7582)

Small doc fix. Reviewing the section on `funding` on docs.npmjs.com, I
noticed some odd code-block formatting, as well as some opportunities to
clarify.

The current weirdness:


![2024-06-02-214100_3840x2160_scrot](https://github.com/npm/cli/assets/205760/5f0a436f-5812-4a97-b4b9-b4183219d4dd)

Glad to see string-or-object worked out.
  • Loading branch information
kemitchell committed Jun 3, 2024
1 parent 92e71e6 commit 93883bb
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions docs/lib/content/configuring-npm/package-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,23 +225,35 @@ npm also sets a top-level "maintainers" field with your npm user info.
### funding

You can specify an object containing a URL that provides up-to-date
information about ways to help fund development of your package, or a
string URL, or an array of these:
information about ways to help fund development of your package, a
string URL, or an array of objects and string URLs:

```json
{
"funding": {
"type" : "individual",
"url" : "http://example.com/donate"
},
}
}
```

```json
{
"funding": {
"type" : "patreon",
"url" : "https://www.patreon.com/my-account"
},
}
}
```

"funding": "http://example.com/donate",
```json
{
"funding": "http://example.com/donate"
}
```

```json
{
"funding": [
{
"type" : "individual",
Expand All @@ -258,7 +270,7 @@ string URL, or an array of these:

Users can use the `npm fund` subcommand to list the `funding` URLs of all
dependencies of their project, direct and indirect. A shortcut to visit
each funding url is also available when providing the project name such as:
each funding URL is also available when providing the project name such as:
`npm fund <projectname>` (when there are multiple URLs, the first one will
be visited)

Expand Down

0 comments on commit 93883bb

Please sign in to comment.