Aria Docs

Ariadocs-ドキュメントテンプレート

next.jsで構築されたこの機能満載のドキュメントテンプレートは、プロジェクトのドキュメントのニーズにぴったりの洗練されたレスポンシブなデザインを提供します。

Ariadocsテンプレートのすべてのバージョンを以下に示します。それぞれが特定のユースケース用に作成されています。

• 高度なドキュメント：詳細なドキュメントのニーズに向けた広範な機能を提供する包括的なテンプレート。詳細な説明と高度な構成を必要とする大規模なプロジェクトに最適です。
  高度なドキュメントを探索してください

• Liteバージョン：簡単なドキュメントのニーズに最適な合理化された、飾り気のないテンプレート。
  Liteバージョンを探索してください

• バージョンのバージョン：履歴ドキュメント追跡を必要とするプロジェクトの強力なオプション。ドキュメントの複数のバージョンを簡単に管理します。
  バージョン化機能をご覧ください

• I18Nサポートバージョン（WIP）：国際的な視聴者向けに設計されたこのバージョンは、包括的な多言語サポートを提供します。
  i18nサポートをプレビューします

クイックスタート

コマンドを使用して、新しいAriadocsプロジェクトを作成できます。

 npx create-aria-doc <project-directory>

予想出力

CLIを実行すると、これに似た出力が期待できます。

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

はじめる

まず、開発サーバーを実行します。

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Vercelに展開します

next.jsアプリを展開する最も簡単な方法は、next.jsの作成者からvercelプラットフォームを使用することです。

詳細については、next.js deploymentドキュメントをご覧ください。

重要な機能

特徴	説明
MDXサポート	MDXでインタラクティブなドキュメントを作成します。
ネストされたページ	ネストされた階層構造でコンテンツを整理します。
ブログセクション	専用のブログセクションを含めます。
目次	自動生成TOCのためのNavigation。
ページネーション	複数のページにコンテンツを分割します。
構文の強調表示	より良い読みやすさのためにコードを強調表示します。
コードラインのハイライトとタイトル	説明的なタイトルを備えた特定の行を強調表示します。
インタラクティブコードブロック	言語固有のインタラクティブコードディスプレイ。
カスタムコンポーネント	ドキュメントにカスタムの再利用可能なコンポーネントを埋め込みました。
ライト＆ダークモード	明るいテーマと暗いテーマの間で切り替えます。
検索機能	組み込みの検索でコンテンツをすばやく見つけます。
コードスイッチャー	コード言語またはバリエーションを切り替えます。
コードコピー	1回のクリックでコードブロックをコピーします。
TOCオブザーバーのハイライト	スクロール時にTOCのアクティブなセクションを強調表示します。
静的サイト生成	静的な高性能サイトを生成します。
seo-optimized	最適な検索エンジンインデックスのために構造化されています。

追加のテーマ