axs/website
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tweak language

Browse Source
This commit is contained in:
Andrew Stryker 2025-02-26 20:15:53 -08:00
parent 81e54db2fc
commit c683d2aba4
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
content/notes/html-in-markdown-recommendation.md
View File

@ -13,10 +13,11 @@ Markdown uses punctuation-based syntax to format text, drawing inspiration from
plain text email conventions. The goal is for Markdown documents to be easy to
read. For concerns that the [specification](https://commonmark.org/) does not
cover, users are free to use HTML. However, the HTML tags that rendering
engines support vary considerably. For example, Hugo prefers
[shortcodes](https://gohugo.io/content-management/shortcodes/) extensions to
raw HTML tags. Generally, best practice is to avoid mixing Markdown and HTML,
as doing so can detract from Markdown’s intended simplicity and readability.
engines support vary considerably. Further, some rendering engines have their
own approach to extensions, like
[shortcodes](https://gohugo.io/content-management/shortcodes/) in Hugo.
Generally, best practice is to avoid mixing Markdown and HTML, as doing so can
detract from Markdown’s intended simplicity and readability.
The following items are exceptions to this rule—cases where HTML provides
functionality or control that Markdown does not.