jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Explain Markdown renderer and specs; minor tidy (#10719)

Browse Source 
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.
This commit is contained in:
David Beitey 2019-10-12 02:08:42 +10:00 committed by Fabian Affolter
parent d8dfed65b7
commit 9869fbb2cc
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_lovelace/markdown.markdown
View File

@ -4,7 +4,10 @@ sidebar_label: Markdown
description: "Markdown card is used to render 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`.
<p class='img'> <p class='img'>
<img src='/images/lovelace/lovelace_markdown.png' alt='Screenshot of the markdown card'> <img src='/images/lovelace/lovelace_markdown.png' alt='Screenshot of the markdown card'>
@ -18,7 +21,7 @@ type:
type: string type: string
content: content:
required: true 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 type: string
title: title:
required: false required: false