HTML в файлах Markdown

Markdown — это формат письма; HTML — это формат публикации. Таким образом, синтаксис Markdown не предназначен для обеспечения полной универсальности HTML, а лишь для наиболее распространенных элементов письменного текста. Если вам нужно сделать что-то более сложное, вы можете использовать любой встроенный тег HTML и теги уровня блока, которые поддерживаются DevSite, в файле Markdown. Нет необходимости указывать, что вы переходите с 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 на уровне блоков

HTML-теги блочного уровня, поддерживаемые DevSite, должны быть отделены от окружающего содержимого пустой строкой. И в отличие от встроенных HTML-тегов, синтаксис Markdown (например, **strong** , *emphasis* и т. д.) в HTML-тегах блочного уровня не отображается, как в примере ниже.

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.

Лучшие практики

Мы рекомендуем форматировать HTML в файлах Markdown следующими способами, чтобы предотвратить ошибки рендеринга на 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.