语义 Markdown file/directory 路径
Semantic Markdown file/directory path
在 Markdown 中处理不打算成为 link 的 file/directory 路径的常见做法是使用 反引号 ,它将内容标记为“代码”。这种做法甚至发生在 SO 上。我的问题是,有没有语义上更正确的选项?我不认为文件路径在技术上被视为“代码”。甚至我自己在这里的话对我来说也很可疑,这使我想到了第二个高度相关的问题。 为什么一条路径会符合这个“不打算成为 links”标准?
有关更多上下文,我在尝试将设置说明添加到编码项目的 README.md 文件时想到了这个问题。在这里,我试图引用一个文件夹,src/io
。稍微反省一下,我的想法是:“也许以不同方式标记这样的路径会更好 - 也许作为 link,即使单击它并不总是有效?”。但是,这不包括像 SO questions/answers 这样的情况,在这种情况下你只有一条假设路径(也许这就是标准?)。
是的,代码跨度是标记文件名和路径的正确方法。
一个 Markdown code span renders to an HTML code 元素。 HTML 规范声明(强调):
The code
element represents a fragment of computer code. This could be an XML element name, a file name, a computer program, or any other string that a computer would recognize.
明确指出文件名是 code
元素可接受的内容。虽然没有具体提及目录路径,但表达“计算机可以识别的任何其他字符串”肯定包括两者。
但是,这是 Markdown,而不是 HTML...那么我可以提醒您,Markdown 是 HTML 的子集,正如原文 Syntax Rules 中所解释的那样。而且,正如那里所解释的...
For any markup that is not covered by Markdown’s syntax, you simply use HTML itself.
因此,在 HTML 中标记文件名和路径的正确方法在 Markdown 中是相同的。当然,由于 Markdown 假设代码跨度(使用背包),您不需要使用原始 HTML code
元素。反引号是一种更易于读写的快捷方式。
但是,什么时候路径不是 links?
只要他们没有指向可到达的位置。在 SO 上,我们经常会看到有关本地文件和目录路径的问题。如果我 post 关于如何访问本地系统上的本地文件的问题,您不会期望单击 link 并访问该文件。我需要为此上传文件。但是,为了按情况正确报告,我需要使用无法在线访问的本地路径。因此,这样的路径不应该是links。不管是伪路径还是真实路径都无所谓
在 Markdown 中处理不打算成为 link 的 file/directory 路径的常见做法是使用 反引号 ,它将内容标记为“代码”。这种做法甚至发生在 SO 上。我的问题是,有没有语义上更正确的选项?我不认为文件路径在技术上被视为“代码”。甚至我自己在这里的话对我来说也很可疑,这使我想到了第二个高度相关的问题。 为什么一条路径会符合这个“不打算成为 links”标准?
有关更多上下文,我在尝试将设置说明添加到编码项目的 README.md 文件时想到了这个问题。在这里,我试图引用一个文件夹,src/io
。稍微反省一下,我的想法是:“也许以不同方式标记这样的路径会更好 - 也许作为 link,即使单击它并不总是有效?”。但是,这不包括像 SO questions/answers 这样的情况,在这种情况下你只有一条假设路径(也许这就是标准?)。
是的,代码跨度是标记文件名和路径的正确方法。
一个 Markdown code span renders to an HTML code 元素。 HTML 规范声明(强调):
The
code
element represents a fragment of computer code. This could be an XML element name, a file name, a computer program, or any other string that a computer would recognize.
明确指出文件名是 code
元素可接受的内容。虽然没有具体提及目录路径,但表达“计算机可以识别的任何其他字符串”肯定包括两者。
但是,这是 Markdown,而不是 HTML...那么我可以提醒您,Markdown 是 HTML 的子集,正如原文 Syntax Rules 中所解释的那样。而且,正如那里所解释的...
For any markup that is not covered by Markdown’s syntax, you simply use HTML itself.
因此,在 HTML 中标记文件名和路径的正确方法在 Markdown 中是相同的。当然,由于 Markdown 假设代码跨度(使用背包),您不需要使用原始 HTML code
元素。反引号是一种更易于读写的快捷方式。
但是,什么时候路径不是 links?
只要他们没有指向可到达的位置。在 SO 上,我们经常会看到有关本地文件和目录路径的问题。如果我 post 关于如何访问本地系统上的本地文件的问题,您不会期望单击 link 并访问该文件。我需要为此上传文件。但是,为了按情况正确报告,我需要使用无法在线访问的本地路径。因此,这样的路径不应该是links。不管是伪路径还是真实路径都无所谓