npm中Markdown标题未正确显示

Question

有人能解释一下为什么在README.md中正确显示的标题在npm中无法呈现（它们显示为“#title”）吗？

例如： https://github.com/Cerealkillerway/versionUpdater （正常）

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

- Cereal Killer

Answer 1

npm使用 markdown-it, 看起来需要在井号和文本之间加一个空格:

#This doesn't work
# This does

我会认为这是良好的风格，即使第一个版本有效也应该使用它。这更适合在纯文本中阅读，这也是Markdown目标的 重要组成部分:

引用：

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

然而，强调可读性。Markdown格式的文档应该可以原样发布，作为纯文本，而不像已经被标记了标签或格式指令。

- Chris

---

这并不完全是正确的答案。NPM将无法正确显示标题大小标签到h#。 - dman

@dman，我不理解你的评论。 "NPM将无法正确显示标题大小标签到h＃"是什么意思？ - Chris

在我的 Github Markdown 中，H6 的颜色是灰色的，而且比 H3 小。但在 NPM 的 markdown-it 中，H6 和 H3 的大小是一样的。`### Usage \n

Using a single callback function` 具有相同的标题大小和颜色。

- dman

@dman，这与OP的问题无关；Markdown是关于内容的，而不是样式。NPM是否对该内容使用了 <h6>标签？如果没有，您应该联系他们并问问为什么。他们可能有某些原因只允许几个标题级别。如果您得到一个您认为应该以不同样式呈现的<h6>，您可能希望询问其样式表。此外，许多开发人员会反对直接将<h6>嵌套在<h3>内，因为它提供了较差的可访问性。考虑修复您的标题等级。 - Chris

不，你错了。标题是“npm中Markdown标题未正确显示”。根据你发布的链接，根据markdown-it： `

这是H1

这是H2

这是H6

此外，我没有嵌套标题。\n`只是手动添加的，以尝试在stackoverflow评论中显示有一个新行。请考虑撤回你的评论，因为它是不正确的、没有根据的，并且会减弱问题的重点。 - dman

@dman，这个问题的_title_可能符合您的问题，但正文并不是。发帖人明确提到标题“像#title一样显示”，并链接到一个曾经出现问题的包。发帖人的标题根本没有被识别为标题。您的问题似乎要么是关于样式，要么是关于转换为HTML后头衔等级未被保留。我很高兴听到您不会在<h3>标签下直接放置<h6>标签，但我仍然坚持我的立场。 - Chris