From 9869fbb2cc71532cb5e9d56121b2226e479d90e4 Mon Sep 17 00:00:00 2001 From: David Beitey Date: Sat, 12 Oct 2019 02:08:42 +1000 Subject: [PATCH] Explain Markdown renderer and specs; minor tidy (#10719) Knowing the specifics of what Markdown syntaxes are supported help when writing content. This change explains which renderer is used and the specs it supports. --- source/_lovelace/markdown.markdown | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index 3f3c15dd81f..bb4585dca91 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -4,7 +4,10 @@ sidebar_label: Markdown description: "Markdown card is used to render markdown" --- -Markdown card is used to render [markdown](http://commonmark.org/help/). +Markdown card is used to render [Markdown](https://commonmark.org/help/). + +The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#/README.md#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`. +

Screenshot of the markdown card @@ -18,7 +21,7 @@ type: type: string content: required: true - description: "Content to render as [markdown](http://commonmark.org/help/). May contain [templates](/docs/configuration/templating/)." + description: "Content to render as [Markdown](https://commonmark.org/help/). May contain [templates](/docs/configuration/templating/)." type: string title: required: false