npm - 从 readme.md 到包中另一个文件的相对链接，在 npmjs 中呈现

Question

我创建了一个 npm 模块，它托管在 npmjs.com 上。
由于模块的结构，我已将文档拆分为通用 readme.md然后是从主 readme.md 链接到的更具体的文件:

.
├──documentation
│   ├── doc1.md
│   └── doc2.md
└── readme.md

readme.md中的链接看起来像这样: [some text](documentation/doc1.md) .他们在本地和他们的 CodeCommit 存储库中工作得很好(我怀疑在 github 中也可以)。
但是发布到 npm 后，链接变成了 https://www.npmjs.com/package/documentation/doc1.md ，这当然是无效的 URL 并导致 404 错误。
我试图弄清楚如何获得相关文件的有效 url，以便我可以创建指向它的链接，但我什至不知道如何获得指向包中文件的直接链接。可能还值得注意的是，该包本身是一个私有(private)组织包，但我已经在测试公共(public)包上尝试过同样的事情并且在那里遇到了同样的问题，所以我认为它不相关。
有谁知道如何从根链接 readme.md以在 npmjs 中工作的方式将文件复制到同一个包中的另一个文件？

Answer 1

我在 npm community 发现了这个问题他们说它已经解决了，所以我自己试着看看出了什么问题？
他们是对的，我错过了一些要点，所以我会写下所有必需的步骤:

确保您在 github/gitlab 上的存储库是公开的

确保在你的 package.json 文件中有正确的 repository正确指向您的存储库的配置

例子:

{
  ...
  "repository": {
    "url": "https://github.com/lalosh/js-library-boilerplate",
    "type": "git"
  }
  ...
}

进行相对链接时，您需要包含来自 repo 根目录的相对路径，包括 .md后缀。

例子:

We can [link](documentation/sub-doc.md) to an inner relative file