DeployEasy
← All documentation

DeployEasy Docs

Writing content with Markdown and MDX

Use Markdown for regular guides and MDX when an interactive component is needed.

Updated 7/10/2026

export const Tip = ({ children }) =>

;

Markdown is suitable for most documentation. MDX adds JSX and components directly inside a document.

Use MDX only when the content genuinely needs a component. Plain Markdown is easier to read and contribute to.

Highlight code with Shiki

Add a language name after the opening code fence. Astro uses Shiki to highlight it during the build:

interface Deployment {
  provider: 'vercel';
  domain: string;
  ready: boolean;
}

const site: Deployment = {
  provider: 'vercel',
  domain: 'deployeasy.io.vn',
  ready: true,
};

Because highlighting is rendered ahead of time, the browser does not need extra JavaScript just to color the code.