始め方

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

プロジェクト構成

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

拡張

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

確認

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

始め方

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

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

参考例

npm create squidoc@latest my-docs
cd my-docs
npm run dev

---
title: API Guide
description: Learn how to use the API.
---

# API Guide

Write your documentation here.

nav: [
  { title: "Getting Started", path: "/getting-started" },
  { title: "API Guide", path: "/api-guide" },
];

npm run check
npm run build
npm run preview