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

rvpgvaaj 于 2023-04-12 发布在其他

关注(0)|答案(1)|浏览(227)

我创建了一个npm模块，托管在npmjs.com上。
由于模块的结构，我将文档分为一般的readme.md和从主readme.md链接到的更具体的文件：

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

readme.md中的链接如下所示：[some text](documentation/doc1.md)。它们在本地和CodeCommit repo中工作得非常好（我怀疑在github中也会很好）。
但是在发布到npm之后，链接变成了https://www.npmjs.com/package/documentation/doc1.md，这当然是一个无效的URL，并导致404错误。
我试着弄清楚如何获得一个有效的URL到文件的问题，所以我可以创建链接，导致它，但我甚至不能找到如何获得一个直接链接到文件的包.它也可能是值得注意的是，包本身是一个私有的组织包，但我已经尝试了同样的事情在一个测试公共包，并有同样的问题，所以我不认为这是相关的.
有谁知道如何以npmjs的方式从根readme.md文件链接到同一个包中的另一个文件吗？

npm

来源：https://stackoverflow.com/questions/62575382/relative-link-from-readme-md-to-another-file-in-package-rendered-in-npmjs

1条答案

按热度按时间

0aydgbwb1#

我在npm community上发现了这个问题，他们说已经解决了，所以我自己试着看看出了什么问题？
他们是对的，我错过了一些要点，所以我会写下所有必需的步骤：
1.确保你在github/gitlab的仓库是公开的
1.确保在package.json文件中有正确指向存储库的适当存储库配置
示例：

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

1.在进行相对链接时，您需要包含来自您的repo根的相对路径，包括.md后缀。
示例：

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

赞(0）回复(0）举报 2023-04-12

我来回答

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

1条答案

相关问题

热门标签

最新问答