Markdown headers 在 npm 中显示不正确
Markdown headers not displayed correctly in npm
有人可以解释为什么 README.md 中的 headers,在 github 中正确显示,却没有在 npm 中呈现(它们显示为“#title”)吗?
npm uses markdown-it,这似乎需要在哈希和文本之间有一个 space:
#This doesn't work
# This does
我认为这是一种很好的风格,即使第一个版本确实有效,也应该使用它。它在纯文本中更具可读性,即 a big part of Markdown's goal:
Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.
有人可以解释为什么 README.md 中的 headers,在 github 中正确显示,却没有在 npm 中呈现(它们显示为“#title”)吗?
npm uses markdown-it,这似乎需要在哈希和文本之间有一个 space:
#This doesn't work
# This does
我认为这是一种很好的风格,即使第一个版本确实有效,也应该使用它。它在纯文本中更具可读性,即 a big part of Markdown's goal:
Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.