Markdown 标头未在 npm 中正确显示

Question

有人可以解释为什么 README.md 中的标题，在 github 中正确显示，没有在 npm 中呈现（它们显示为“#title”）？

例如：https : //github.com/Cerealkillerway/versionUpdater （好的）

https://www.npmjs.com/package/version-updater （标题错误）

Answer 1

npm 使用 markdown-it，这似乎需要哈希值和文本之间有一个空格：

\n

#This doesn\'t work\n# This does\n

\n

我认为这是一种很好的风格，即使第一个版本确实有效，也应该使用。纯文本的可读性更高，这是Markdown 目标的重要组成部分：

\n

\n

Markdown 旨在尽可能易于阅读和易于编写。

\n

然而，可读性是最重要的。Markdown 格式的文档应该可以按原样作为纯文本发布，而不会看起来像是用标签或格式说明标记的\xe2\x80\x99s。

\n

\n