Markdown is een schrijfformaat; HTML is een publicatieformaat. De Markdown-syntaxis is dus niet bedoeld om de volledige veelzijdigheid van HTML te bieden, maar alleen de meest voorkomende elementen voor geschreven tekst. Als u iets ingewikkelders moet doen, kunt u elke inline HTML-tag en tags op blokniveau gebruiken die door DevSite worden ondersteund in een Markdown-bestand. Het is niet nodig om aan te geven dat u overschakelt van Markdown naar HTML, gebruik gewoon de HTML-tag zoals in het onderstaande voorbeeld.
This sentence is in Markdown with a <b>bold inline HTML tag</b>.
Inline-HTML
Inline HTML-tags kunnen worden gebruikt binnen een Markdown-paragraaf, lijstitem of koptekst, en ze kunnen ook Markdown-syntaxis bevatten (bijvoorbeeld **strong**
, *emphasis*
, enz.). Dit is handig als u de aandacht wilt vestigen op een stukje code, zoals in het onderstaande voorbeeld.
This is a Markdown paragraph about Java:
<code>System.out.format("The square of *%d* is *%f*.*%n*", i, r);</code>
HTML op blokniveau
HTML-tags op blokniveau die door DevSite worden ondersteund, moeten door een lege regel van de omringende inhoud worden gescheiden. En in tegenstelling tot inline HTML-tags wordt de Markdown-syntaxis (bijv. **strong**
, *emphasis*
, etc.) in HTML-tags op blokniveau niet weergegeven zoals in het onderstaande voorbeeld.
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.
Beste praktijken
We raden aan HTML in Markdown-bestanden op de volgende manieren op te maken om weergavefouten op DevSite te voorkomen.
Gebruik geen niet-ondersteunde HTML-tags op blokniveau DevSite ondersteunt veel HTML-tags op blokniveau; maar als u een niet-ondersteunde code opneemt, wordt uw HTML als tekst weergegeven of wordt de code verbroken.
Voeg geen extra tabs of spaties toe bij het inspringen. Begin- en eindtags op blokniveau mogen niet worden ingesprongen met tabs of spaties. Sommige editors voegen automatisch extra tabbladen of spaties toe – pas op!
This is a regular paragraph in Markdown.
<p>
This is an HTML paragraph with proper indentation!
</p>
This is a regular paragraph in Markdown.
Vergeet niet dat niet-ingesprongen code relatief is
U hoeft bijvoorbeeld geen begin- en eindtags op blokniveau te laten inspringen wanneer u lijsten maakt in 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
Voeg geen lege regel toe tussen een begin- en eindtag
Dit is gemakkelijk te doen als u schakelt tussen Markdown en HTML, maar een simpele lege regel kan een pagina gemakkelijk verkeerd weergeven.
This is a regular paragraph in Markdown.
<section>
<p>
hello
</p>
<p>
hello
</p>
</section>
This is a regular paragraph in Markdown.