Markdown

This field lets you display markdown content. It supports GitHub Flavored Markdown.

Good to know:

You can swizzle this component to customize it with the Refine CLI

Usage

Let's see how we can use <MarkdownField> in a show page:

localhost:3000

import { useShow } from "@refinedev/core";
import {
  Show,
  MarkdownField,
} from "@refinedev/antd";
import { Typography } from "antd";

const { Title, Text } = Typography;

const SampleShow: React.FC = () => {
  const { queryResult } = useShow<IPost>();
  const { data, isLoading } = queryResult;
  const record = data?.data;

  return (
    <Show isLoading={isLoading}>
      <Title level={5}>Id</Title>
      <Text>{record?.id}</Text>

      <Title level={5}>Content</Title>

      <MarkdownField value={record?.content} />
    </Show>
  );
};

interface IPost {
  id: number;
  title: string;
  content: string;
}

API Reference

Properties

Property	Type	Description
value	`string`	Markdown data to render

Example

View Source Code

Run on your local

npm create refine-app@latest -- --example input-custom

Usage​

API Reference​

Properties​

Example​

Usage

API Reference

Properties

Example