Vibecoding Manual

VitePressを使ってvibecodingマニュアルを作成し、GitHub Pagesで公開するためのリポジトリ構成です。

必要環境

• Node.js 18以上（最新のLTS推奨）
• npm 9以上

初回セットアップ:

npm install

ローカルプレビュー:

npm run docs:dev

本番ビルド:

npm run docs:build

GitHub Pagesへデプロイするには、mainブランチにプッシュすると.github/workflows/deploy.ymlが自動で走り、gh-pagesブランチへ公開されます。必要に応じてDOCS_BASE環境変数をGitHub Actionsのリポジトリシークレットに設定し、/<リポジトリ名>/の形式を指定してください。

ディレクトリ構成

.
├─ docs
│  ├─ .vitepress
│  │  └─ config.ts
│  ├─ guide
│  │  ├─ faq.md
│  │  ├─ how-to-use.md
│  │  ├─ intro.md
│  │  ├─ reference.md
│  │  └─ style-guide.md
│  ├─ index.md
│  └─ public
│     └─ logo.svg
├─ .github
│  └─ workflows
│     └─ deploy.yml
├─ .gitignore
└─ package.json

GitHub Pages設定のヒント

1. リポジトリのSettings > Pagesで「Build and deployment」をGitHub Actionsに切り替えます。
2. リポジトリが<user>.github.io形式ならDOCS_BASE=/でOKです。プロジェクトリポジトリの場合はDOCS_BASE=/<repo>/を設定します。
3. npm ciを使うためにpackage-lock.jsonをコミットしてください。

次のTODO例

• faviconの追加（docs/public/favicon.ico）
• チーム独自の章立てやテンプレートの追記
• 自動リンクチェックやプレビューコメントのWorkflow拡張