MDX

Squidoc は、プラグイン、テーマ、SEO 向けの既定設定を備えた静的ファーストのドキュメント基盤です。Markdown を書き、docs.config.ts で設定し、高速な静的サイトとして公開できます。

プロジェクト構成

記事は docs/、任意の Astro ページは pages/、サイト情報・ナビゲーション・プラグイン・テーマは docs.config.ts で管理します。

拡張

プラグインは検索、SEO、コードブロック、バージョン管理、国際化、生成ファイルを追加します。テーマはレイアウト、ナビゲーション、スロットを制御します。

確認

公開前に npm run check、npm run build、npm run preview を実行します。

MDX

このページは英語版ドキュメントに対応しており、サポートされるすべての言語で現在のバージョンのカバレッジをそろえます。

始め方 · 設定 · プラグイン · テーマ · デプロイ

参考例

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>