github - 如何为 github 和 npm 指定不同的自述文件

标签 github npm documentation publish readme

两者都使用 README.md作为您发布时的描述。通常的做法是使用单个共享文件。

但是如果我需要不同的自述文件并且仍然从一个本地存储库发布它而不需要手动编辑/替换怎么办

聚苯乙烯

我尝试使用 "readme": "npm-readme.md"在 package.json 中,但它显示该字段的值,而不是文件的内容

最佳答案

好问题伙伴!出于多种原因,我更喜欢 GitHub 而非 NPM,例如

a) NPM 上的列变窄,所有表格都开始滚动
b) 当图像从左到右对齐时没有填充
c) TOC 导航不起作用,因为在 GitHub 和 npm 上生成的 anchor 链接不同

因此我找到了一个解决方案:添加一个 README文件,NPM 将读取该文件,并保留 README.md GitHub 将读取的文件。 Easy-peasy 但不能保证它会继续工作。

关于github - 如何为 github 和 npm 指定不同的自述文件,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41297117/

相关文章:

r - 在 github 存储库中搜索定义给定函数的文件

github - 在 Github 中查看特定日期给定目录的提交

php - 如何将 PHP 代码块放入 PHPDoc DocBlock

ios - xcode 'boost/config/user.hpp' 找不到文件

makefile - 记录 makefile 中使用的变量

language-agnostic - 记录 getter 和 setter

git - 在 git revert 中给 -m 开关赋予什么值?

git - 反之亦然如何将HDFS中的文件获取/复制到Git存储库中?

php - Laravel 中 NPM、Composer 和 Bower 的区别?

node.js - Cordova 安装错误 : path issue (? ) - 错误代码 ENOENT