diff --git a/docs/MarkdownField.md b/docs/MarkdownField.md index 3d89aceedfa..88d6b7dce35 100644 --- a/docs/MarkdownField.md +++ b/docs/MarkdownField.md @@ -7,6 +7,8 @@ title: "The MarkdownField Component" This [Enterprise Edition](https://marmelab.com/ra-enterprise) component allows to render Markdown data as HTML. +![MarkdownField preview](https://marmelab.com/ra-enterprise/modules/assets/ra-markdown/latest/markdown-field-preview.png) + ```jsx import { Show, SimpleShowLayout, TextField } from 'react-admin'; import { MarkdownField } from '@react-admin/ra-markdown'; @@ -21,4 +23,19 @@ const PostShow = () => ( ); ``` +**Tip**: If you want to display raw (unformatted) markdown, use `` instead: + +```tsx +import { Show, SimpleShowLayout, TextField } from 'react-admin'; + +const PostShow = () => ( + + + + + + +); +``` + Check [the `ra-markdown` documentation](https://marmelab.com/ra-enterprise/modules/ra-markdown) for more details.