npm / npm/documentation

Add support for project_urls, similar to PyPI

Open
#1,552 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
711
Forks
4.2k
Avg merge
4d 16h
Merged PRs (30d)
3

Description

I'd like to add an arbitrary link to our package's page on npmjs.com that is highlighted in the right-hand side navigation by adding it to our package's package.json file without adding it to ourREADME.md. Arbitrary URLs could include documentation, sponsorship, and other useful links. [Currently it appears that only homepageandrepository` are supported](https://docs.npmjs.com/creating-a-package-json-file#default-values-extracted-from-the-current-directory).

PyPI offers this feature in either its setup.py or pyproject.toml project file.

[project.urls]
Repository = "https://github.com/plone/plone-sphinx-theme"
Documentation = "https://plone-sphinx-theme.readthedocs.io/"

This renders as shown in the screenshot and following URL.

https://pypi.org/project/plone-sphinx-theme/

Image

Is this something you would consider useful?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the package.json metadata, especially the existing homepage and repository support, and compare it with the linked PyPI project.urls example. Determine where arbitrary links should be documented and what rendering or behavior would define completion; the issue does not identify an implementation file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.