Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/book-qa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ jobs:
cache: npm
cache-dependency-path: book-formatter/package-lock.json

- name: Book metadata consistency check
run: node scripts/check-metadata-consistency.js

- name: Install dependencies (book-formatter)
working-directory: book-formatter
run: npm ci
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ __pycache__/
.pytest_cache/

# Documentation build
docs/Gemfile.lock
_site/
.sass-cache/
.jekyll-cache/
Expand Down
58 changes: 58 additions & 0 deletions .markdownlint-src.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"default": true,
"MD003": {
"style": "atx"
},
"MD004": {
"style": "dash"
},
"MD007": {
"indent": 2
},
"MD013": false,
"MD022": false,
"MD024": {
"siblings_only": true
},
"MD025": false,
"MD026": {
"punctuation": ".,;:!"
},
"MD029": false,
"MD031": false,
"MD032": false,
"MD033": {
"allowed_elements": [
"br",
"hr",
"img",
"a",
"details",
"summary",
"code",
"pre",
"sup",
"sub",
"kbd"
]
},
"MD034": false,
"MD040": false,
"MD041": false,
"MD046": {
"style": "fenced"
},
"MD047": false,
"MD048": {
"style": "backtick"
},
"MD049": {
"style": "underscore"
},
"MD050": {
"style": "asterisk"
},
"MD009": false,
"MD036": false,
"MD060": false
}
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@

### 📋 クイックスタート
```bash
npm install # 依存関係インストール
npm run build # ビルド
npm run preview # ローカルプレビュー
```

詳細は [SETUP_V2.md](SETUP_V2.md) を参照してください。
PUPPETEER_SKIP_DOWNLOAD=true npm ci # 依存関係インストール
npm run test:light # メタデータ確認 + 軽量QA + Jekyllビルド
npm run preview # ローカルプレビュー
```

詳細は [SETUP_V2.md](SETUP_V2.md) を参照してください。

### 🧪 品質確認

- `npm run check:metadata`: `package.json`、`book-config.json`、`docs/_config.yml`、`docs/index.md`、公開ナビゲーションの整合性を確認します。
- `npm run test:light`: メタデータ確認、legacy `src/` Markdown lint、公開 `docs/` の Jekyll ビルドをまとめて実行します。Jekyll build 前に `docs/Gemfile` の bundle を確認し、未導入ならインストールします。
- `npm run build:generate`: `src/` から `docs/` を再生成する旧テンプレート用コマンドです。通常の公開確認は `npm run build` を使用します。

## 📚 書籍概要

Expand Down Expand Up @@ -257,7 +263,7 @@ AI協働に最適化された開発環境設定
**著者**: 株式会社アイティードゥ 太田和彦
**発行日**: 2025年6月1日

- Email: author@example.com
- Email: knowledge@itdo.jp
- Twitter: @username
- LinkedIn: /in/username

Expand Down
3 changes: 2 additions & 1 deletion book-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"repository": {
"url": "https://github.com/itdojp/github-workflow-book",
"zenn": "https://zenn.dev/itdojp/books/github-workflow-ai"
}
},
"version": "1.1.0"
},
"deployment": {
"sourceFolder": "docs",
Expand Down
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
title: "AI開発のためのGitHubワークフロー実践ガイド"
description: "ChatGPT/GitHub Copilot/Claude等のAI開発者ツールとGitHubを統合した開発手法を体系的に解説。AI時代のソフトウェア開発に必要なワークフロー、セキュリティ、ガバナンス、大規模開発の実践的ノウハウを網羅。"
author: "太田和彦"
version: "1.1.0"
baseurl: "/github-workflow-book"
url: "https://itdojp.github.io"

Expand Down
3 changes: 3 additions & 0 deletions docs/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ appendices:
path: /appendices/appendix-f/
- title: 付録G:参考資料
path: /appendices/appendix-g/
afterword:
- title: あとがき
path: /afterword/
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
layout: book
order: 1
title: "AI開発のためのGitHubワークフロー実践ガイド"
author: "株式会社アイティードゥ"
version: "1.0.0"
author: "太田和彦"
version: "1.1.0"
permalink: /
---

Expand Down Expand Up @@ -196,6 +196,10 @@ ChatGPT/GitHub Copilot/Claude等のAI開発者ツールとGitHubを統合した
#### [付録F:推奨VS Code拡張機能](appendices/appendix-f/)
#### [付録G:参考資料](appendices/appendix-g/)

### あとがき

#### [あとがき](afterword/)

---

## 📖 書籍について
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 17 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "book-publishing-template-improved",
"version": "2.0.0",
"description": "Improved Book Publishing Template with Easy Setup",
"author": "Book Publishing Template Contributors",
"name": "github-workflow-book",
"version": "1.1.0",
"description": "ChatGPT/GitHub Copilot/Claude等のAI開発者ツールとGitHubを統合した開発手法を体系的に解説。AI時代のソフトウェア開発に必要なワークフロー、セキュリティ、ガバナンス、大規模開発の実践的ノウハウを網羅。",
"author": "太田和彦(株式会社アイティードゥ) <knowledge@itdo.jp>",
"license": "CC-BY-NC-SA-4.0",
"repository": {
"type": "git",
Expand All @@ -13,14 +13,16 @@
},
"scripts": {
"setup": "node easy-setup.js",
"build": "node scripts/build-simple.js",
"build": "cd docs && (bundle check || bundle install) && bundle exec jekyll build --config _config.yml --source . --destination ../_site",
"build:full": "node scripts/build.js",
"preview": "npm run build && npx http-server public -p 8080 --silent",
"preview": "npm run build && npx http-server _site -p 8080 --silent",
"deploy": "bash scripts/deploy.sh",
"clean": "rm -rf public output temp",
"lint:light": "markdownlint 'src/**/*.md' --ignore node_modules",
"test:light": "npm run lint:light && npm run build",
"help": "echo 'Available commands:\n npm run setup - Interactive setup\n npm run build - Build the book\n npm run preview - Local preview\n npm run deploy - Deploy to GitHub Pages'"
"clean": "rm -rf _site public output temp",
"lint:light": "markdownlint --config .markdownlint-src.json 'src/**/*.md' --ignore node_modules",
"test:light": "npm run check:metadata && npm run lint:light && npm run build",
"help": "echo 'Available commands:\n npm run setup - Interactive setup\n npm run build - Build the book\n npm run preview - Local preview\n npm run deploy - Deploy to GitHub Pages'",
"build:generate": "node scripts/build-simple.js",
"check:metadata": "node scripts/check-metadata-consistency.js"
},
"dependencies": {
"fs-extra": "^11.3.0",
Expand All @@ -38,15 +40,14 @@
"minimatch": "^10.2.1"
},
"keywords": [
"github",
"workflow",
"ai-development",
"book",
"publishing",
"markdown",
"github-pages",
"template",
"easy-setup"
"github-pages"
],
"bugs": {
"url": "https://github.com/itdojp/github-workflow-book/issues"
},
"homepage": "https://github.com/itdojp/github-workflow-book#readme"
"homepage": "https://itdojp.github.io/github-workflow-book/"
}
Loading
Loading