Squidoc

MDX

本页聚焦 MDX 文件，说明它在 Squidoc 项目中的工作方式。

你将配置什么

你将学习如何在 docs 树中识别与 Markdown 并存的 .mdx。

发布前检查

JSX 组件支持仍有限；每次修改 MDX 后请检查 build。

相关阅读

配置 · 插件 · 部署

示例

npx squidoc add plugin @squidoc/plugin-mdx

export default defineConfig({
  plugins: [
    "@squidoc/plugin-seo",
    "@squidoc/plugin-codeblocks",
    "@squidoc/plugin-article-tree",
    "@squidoc/plugin-mdx",
  ],
});

---
title: API Guide
description: A guide written in an MDX file.
---

# API Guide

Regular Markdown content works here.

import Callout from "../components/Callout";

<Callout>This is not supported yet.</Callout>