Markdown 是一种书写格式;HTML 是一种发布格式。因此,Markdown 语法并不能提供 HTML 的全部功能,而只提供书面文本中最常见的元素。如果您需要执行更复杂的操作,可以在 Markdown 文件中使用 DevSite 支持的任何内嵌 HTML 标记和块级标记。您无需指明要从 Markdown 切换为 HTML,只需使用下例中的 HTML 标记即可。
This sentence is in Markdown with a <b>bold inline HTML tag</b>.
内嵌 HTML
内嵌 HTML 标记可以在 Markdown 段落、列表项或标题中使用,还可以包含 Markdown 语法(例如**strong**
、*emphasis*
等)当您想要注意一些代码时,如下例所示,这会非常有用。
This is a Markdown paragraph about Java:
<code>System.out.format("The square of *%d* is *%f*.*%n*", i, r);</code>
块级 HTML
DevSite 支持的块级 HTML 标记必须通过空白行与周围的内容分隔开。而与内嵌 HTML 标记不同的是,Markdown 语法(例如**strong**
、*emphasis*
等)。
This is a Markdown paragraph that explains Java format strings:
// required blank line
<pre>
System.out.format("The square of *%d* is *%f*.*%n*", i, r);
</pre>
// required blank line
This is another Markdown paragraph.
最佳做法
我们建议通过以下方式在 Markdown 文件中设置 HTML 格式,以防在 DevSite 上呈现错误。
请勿使用不受支持的块级 HTML 标记 DevSite 支持许多块级 HTML 标记;但添加不受支持的代码会导致您的 HTML 以文本形式呈现或破坏代码。
缩进时不要添加额外的制表符或空格 块级开始和结束标记不应使用制表符或空格来缩进。有些编辑器会自动添加额外的制表符或空格,请注意!
This is a regular paragraph in Markdown.
<p>
This is an HTML paragraph with proper indentation!
</p>
This is a regular paragraph in Markdown.
不要忘记,未缩进的代码是相对的
例如,在 Markdown 中创建列表时,不需要缩进块级开始和结束标记。
* This is a list item in Markdown
<p>This is an HTML paragraph with proper indentation!</p>
* This is a list item in Markdown
请勿在开始和结束标记之间添加空白行
在 Markdown 和 HTML 之间切换时,这很容易做到,但简单的空白行很容易无法正确呈现网页。
This is a regular paragraph in Markdown.
<section>
<p>
hello
</p>
<p>
hello
</p>
</section>
This is a regular paragraph in Markdown.