Markdown标头在npm中无法正确显示

时间:2015-08-09 18:09:30

标签: npm markdown

有人可以解释为什么在github中正确显示的README.md中的标题不会在npm中呈现(它们显示为"#title")?

例如: https://github.com/Cerealkillerway/versionUpdater(确定)

https://www.npmjs.com/package/version-updater(标题错误)

1 个答案:

答案 0 :(得分:4)

npm uses markdown-it,似乎需要哈希和文字之间的空格:

#This doesn't work
# This does

我认为这是好的风格,即使第一个版本确实有用也应该使用。它在纯文本中更具可读性,即a big part of Markdown's goal

  

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

     然而,

可读性首先强调了。 Markdown格式的文档应该像普通文本一样可以发布,而不会被标记为标记或格式化说明。