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>