# Markdown

Full markdown renderer for terminal



<ComponentPreview base="ink" name="markdown-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/markdown
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="ink" name="markdown" title="components/ui/markdown.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Markdown } from "@/components/ui/markdown";
```

```tsx
<Markdown>{`# Welcome\n\nThis is **bold** and *italic* text.`}</Markdown>
```

Examples [#examples]

Streaming [#streaming]

While tokens arrive, enable `streaming` to blink a cursor after the last line and auto-close an odd number of Markdown fenced code blocks so partial streams still render.

<ComponentPreview base="ink" name="markdown-streaming-demo" />

API Reference [#api-reference]

Markdown [#markdown]

| Prop        | Type      | Default    |
| ----------- | --------- | ---------- |
| `children`  | `string`  | `required` |
| `width`     | `number`  | -          |
| `streaming` | `boolean` | `false`    |
| `cursor`    | `string`  | `"▌"`      |