これは何？
EpoCanvas Docs は EpoCanvas プロジェクトの公式ドキュメントプロジェクトです。平たく言えば、このリポジトリが納品するのは「ドキュメント」そのものであり、いまあなたが閲覧しているサイト一式がその成果物です。リポジトリには他のソフトウェアの機能コードは含まれておらず、探している「製品」の正体がこのドキュメントサイトです。
「ドキュメントプロジェクト」とはどういうことか
この言葉には 2 つの意味があり、両方とも同時に成り立ちます:
- これは取扱説明書です。 内容は「何であるか、どう使うか、どう変えるか、どう公開するか」を軸に構成されています: 閲覧画面の操作方法、新しいドキュメントの書き方、設定を変更する場所、デプロイコマンドなど。書く目的はただ 1 つ、EpoCanvas を手にした人があちこち聞いて回らなくても、ドキュメントどおりに作業をやり遂げられるようにすることです。
- それ自体が、そのまま実行できる Web サイトシステムでもあります。 リポジトリをローカルに clone し、
pnpm installとpnpm run devの 2 つのコマンドを実行すれば、いま目の前にあるのとまったく同じサイトが手に入ります。コード一式は Astro 5 と Starlight ベースで MIT ライセンスなので、丸ごと持ち出して自分のプロジェクトのドキュメントサイトに作り変えられます。
もう 1 つ見落とされがちな特徴があります: このドキュメントが紹介する機能を、あなたはいままさに実際に使っています。3 カラムの閲覧レイアウト、Ctrl + K でのサイト全体検索、右上での 10 言語のその場切り替え——ドキュメントに書かれているのは、このサイト自身が実装している機能そのものなので、読みながら試せばそのまま確かめられます。
実際にどんな役割を果たすのか
読者の立場別に整理すると、このドキュメントプロジェクトは 3 つの役割を担います:
| あなたの立場 | できること | おすすめの始め方 |
|---|---|---|
| 調べものをしたいだけの読者 | ある機能の使い方や、あるエラーの解決方法を調べる | トップバーの検索ボックスか Ctrl + K のサイト全体検索で、該当セクションへ直接ジャンプ |
| 自分のドキュメントサイトを立てたい開発者 | そのまま動くドキュメントサイトのソース一式とデプロイ手順を提供 | 製品概要 → クイックスタート → デプロイ |
| ドキュメントを書く執筆者 | ファイルの置き場所、書式、画像の置き方、公開方法を規定 | 「執筆とコンテンツ管理」グループの 3 つの章 |
一言でまとめると: 利用者には分かりやすく、開発者には持ち帰りやすく、執筆者には指針を。
このプロジェクトに含まれる内容
サイドバーは 5 つのグループに分かれており、それぞれが次の問いに答えます:
- 製品概要とスタートガイド: これは何？ ローカルでどう動かす？
- 主要機能と使い方ガイド: 閲覧画面、検索、多言語、ナビゲーションの具体的な使い方
- 執筆とコンテンツ管理: 新しいドキュメントの書き方、Markdown の整形とレンダリングのルール
- 設定とカスタマイズ: サイトタイトル、ナビゲーションメニュー、テーマカラーはどこで変える？ コンポーネントはどう変える？
- リリースとデプロイ運用: どう公開し、ドメインを設定し、SEO とバージョン管理をするか？
各記事は独立して参照でき、順番に通読する必要はありません。
よくある 2 つの誤解
誤解その 1: 「これは何かのソフトの説明書だから、そのソフト本体を探さないと」 このリポジトリにあるのはドキュメントサイトのソースコードだけで、他のソフトウェアのコードはありません。ドキュメントが実際に解説しているのは、このドキュメントサイトシステム自体の使い方、カスタマイズ、デプロイです。
誤解その 2: 「閲覧専用のサイトだから、ダウンロードしても役に立たない」 逆です。ソースコードは GitHub で完全に公開されており、ローカルならコマンド 2 つで実行できます。テンプレートとして自分のプロジェクトのドキュメントサイトに作り変えることは、まさにこのプロジェクトが設計時に想定している用途の 1 つです。
次のステップ
- 製品の位置づけ、コア機能、技術選定の完全な紹介を見たい方は、製品概要とコアバリュー をご覧ください。
- すぐにローカルでサイトを動かしたい方は、クイックスタート (3分で起動) をご覧ください。
- 特定の問題を調べたいだけなら、トップバーの検索ボックスか
Ctrl + Kでキーワードを検索してください。