> ## Documentation Index
> Fetch the complete documentation index at: https://anvil.servicetitan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Markdown – Code

> The Markdown component renders GitHub Flavored Markdown as Carto-styled HTML.

export const LiveCode = ({children, customHeight, clickToLoad, example, fullWidth, fullHeight, hideCodeInLiveCode, screenshot, screenshotOnly, showCode: showCodeProp}) => {
  const SCREENSHOTS_BASE = "https://servicetitan.github.io/anvil2-docs-live-code/screenshots";
  const STACKBLITZ_BASE = "https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples";
  const [showCodeBlock, setShowCodeBlock] = useState(showCodeProp ?? false);
  const [isLocalOverride, setIsLocalOverride] = useState(false);
  useEffect(() => {
    const examplePath = `/images/live-code-screenshots-tmp/${example}.png`;
    fetch(examplePath, {
      method: "HEAD"
    }).then(r => {
      if (r.ok) setIsLocalOverride(true);
    }).catch(() => {});
  }, [example]);
  const screenshotBase = isLocalOverride ? "/images/live-code-screenshots-tmp" : SCREENSHOTS_BASE;
  if (screenshotOnly) {
    return <Frame className="flex flex-col">
        <div className="flex dark:hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#FFFFFF"
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>
        <div className="hidden dark:flex" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#141414"
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>
      </Frame>;
  }
  if (screenshot) {
    return <Frame className="flex flex-col -mb-2">
        <div className="flex dark:hidden bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>

        <div className="hidden dark:flex bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      background: "#141414",
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>

        <div className="flex justify-end items-center text-xs py-2 px-1 gap-4">
          {!showCodeProp ? <button className="inline-flex justify-end items-center text-gray-700 dark:text-gray-50 hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1 cursor-pointer" onClick={() => setShowCodeBlock(!showCodeBlock)} style={{
      appearance: "none"
    }}>
              <Icon icon="code" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
              <span>{showCodeBlock ? "Hide code" : "Show code"}</span>
            </button> : null}

          <a className="inline-flex justify-end items-center hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1" href={`${STACKBLITZ_BASE}/${example}?file=src/App.tsx`} target="_blank" rel="noreferrer">
            <Icon icon="bolt" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
            <span>StackBlitz demo</span>
          </a>
        </div>

        <div className="grid transition-[grid-template-rows] duration-300 ease-in-out overflow-auto overflow-y-hidden overflow-x-auto" style={showCodeBlock ? {
      gridTemplateRows: "1fr"
    } : {
      gridTemplateRows: "0fr"
    }}>
          <div style={{
      minHeight: 0,
      overflowX: "auto",
      overflowY: "hidden",
      marginBlockStart: "-1.25rem",
      marginBlockEnd: "-1.5rem"
    }}>
            {children}
          </div>
        </div>
      </Frame>;
  } else {
    return <div style={{
      display: "flex",
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px",
      resize: "vertical",
      overflow: "auto"
    }}>
        <iframe title={example} style={{
      flex: 1,
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px"
    }} src={`${STACKBLITZ_BASE}/${example}?embed=1&hideNavigation=1&hideExplorer=1&terminalHeight=0&file=src/App.tsx${clickToLoad ? "&ctl=1" : ""}${hideCodeInLiveCode ? "&view=preview" : ""}`} allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts" />
      </div>;
  }
};

<Tabs>
  <Tab title="Implementation">
    <LiveCode showCode example="ai-kit-markdown" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source = [
        "# Page title",
        "",
        "A paragraph with **bold**, *emphasis*, and a [link](https://example.com).",
        "",
        "Inline `code` sits between words.",
      ].join("\n");

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    To use the `Markdown`, import it from `@servicetitan/anvil2-ai-kit` and pass a required markdown string through `source`. The kit forbids `children`.

    ```tsx theme={null}
    import { Markdown } from "@servicetitan/anvil2-ai-kit";

    function ExampleComponent() {
      return <Markdown source={"# Summary\n\nCompleted **3 tasks**."} />;
    }
    ```

    `Markdown` enables GitHub Flavored Markdown, including tables, strikethrough, task lists, and autolinks.

    ### Headings

    Headings render through [`Text`](/docs/kits/ai-kit/components/text/code) so semantic levels and the Carto headline scale remain aligned.

    <LiveCode showCode example="ai-kit-markdown-headings" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source = [
        "# Heading 1",
        "## Heading 2",
        "### Heading 3",
        "#### Heading 4",
      ].join("\n");

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Inline formatting

    Markdown supports emphasis, strong text, strikethrough, inline code, and links.

    <LiveCode showCode example="ai-kit-markdown-inline-formatting" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source =
        "A paragraph with **bold**, *emphasis*, `inline code`, and a [link](https://example.com).";

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Lists and task lists

    Ordered and unordered lists support nesting. GitHub task-list checkboxes are read-only.

    <LiveCode showCode example="ai-kit-markdown-lists" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source = [
        "- First item",
        "- Second item",
        "  - Nested item",
        "",
        "1. First step",
        "2. Second step",
        "",
        "- [x] Completed task",
        "- [ ] Open task",
      ].join("\n");

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Code

    Inline code and fenced code blocks receive separate Carto treatments.

    <LiveCode showCode example="ai-kit-markdown-code" screenshot fullWidth>
      ````tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source = [
        "Inline `code` sits between words.",
        "",
        "```ts",
        "function greet(name: string) {",
        "  return `Hello, ${name}!`;",
        "}",
        "```",
      ].join("\n");

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ````
    </LiveCode>

    ### Tables

    GitHub Flavored Markdown tables render through the kit's responsive table implementation.

    <LiveCode showCode example="ai-kit-markdown-tables" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Markdown } from "@servicetitan/anvil2-ai-kit";

      const source = [
        "| Invoice | Status |",
        "| ------- | ------ |",
        "| #1024 | Paid |",
        "| #1025 | Overdue |",
      ].join("\n");

      function App() {
        return (
          <div style={{ maxWidth: "44rem" }}>
            <Markdown source={source} />
          </div>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Links

    Relative and same-origin links stay in the current tab. External HTTP(S) links open in a new tab with `rel="noopener noreferrer"`.

    ## React Accessibility

    * Markdown headings preserve their source heading levels.
    * Images use their markdown alt text. Images without alt text render with an empty `alt` attribute.
    * Task-list checkboxes are disabled because rendered markdown is read-only.
    * Tables preserve header and data-cell semantics.
  </Tab>

  <Tab title="Markdown Props">
    ```tsx theme={null}
    <Markdown source={"# Summary\n\nCompleted **3 tasks**."} />
    ```

    ## `Markdown` Props

    The `Markdown` accepts the following props and forwards remaining `<div>` attributes except `children` and `style`.

    <ParamField path="source" type="string" required>
      Markdown source parsed with GitHub Flavored Markdown enabled.
    </ParamField>

    <ParamField path="className" type="string">
      Class merged onto the root wrapper.
    </ParamField>
  </Tab>
</Tabs>