@ncukondo/slide-generation 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-03-15
+
+### Added
+
+#### Core Features
+- YAML-based source file format for presentations
+- Template system with Nunjucks engine
+- Zod-based schema validation for templates
+- Pipeline architecture (Parser -> Transformer -> Renderer)
+
+#### Templates
+- **Basic templates**: title, section, bullet-list, numbered-list
+- **Diagram templates**: flow-chart, cycle-diagram, hierarchy, matrix, timeline
+- **Data templates**: table, comparison-table
+- **Layout templates**: two-column, three-column, image-text, gallery
+- **Special templates**: quote, code-block, bibliography, custom
+
+#### CLI Commands
+- `convert` - Convert YAML source to Marp Markdown
+- `validate` - Validate source files
+- `watch` - Watch files for changes and auto-convert
+- `preview` - Preview with Marp CLI
+- `templates list/info/example` - Template management
+- `icons list/search/preview` - Icon management
+- `init` - Initialize new project
+
+#### Icon System
+- Icon registry with aliases
+- Support for Material Icons and Heroicons (CDN)
+- Custom icon support
+- Icon caching with TTL
+
+#### Reference System
+- Integration with reference-manager CLI
+- Citation key extraction from YAML
+- Multiple citation styles support
+- Fallback handling when reference-manager unavailable
+
+#### Documentation
+- README with installation and usage instructions
+- Example presentations (basic, academic, corporate)
+- Specification documents in `spec/` directory
+
+### Technical Details
+- TypeScript with strict mode
+- ESM modules
+- Node.js >= 22.0.0 requirement
+- Vitest for testing (500+ tests)
+- oxlint for linting

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Takeshi Kondo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,248 @@
+# slide-generation
+
+A CLI tool to generate Marp-compatible Markdown from YAML source files, designed for both humans and AI to create presentations easily.
+
+## Features
+
+- **YAML-based source files** - Structured, readable, and easy to generate programmatically
+- **Template system** - Reusable templates for various slide types
+- **Icon support** - Built-in icon registry with Material Icons, Heroicons, and custom icons
+- **Reference management** - Integration with reference-manager CLI for citations
+- **Watch mode** - Auto-convert on file changes
+- **Marp compatible** - Output works directly with Marp CLI
+
+## Installation
+
+```bash
+# Using npm
+npm install -g @ncukondo/slide-generation
+
+# Using pnpm
+pnpm add -g @ncukondo/slide-generation
+
+# Or run directly with npx
+npx @ncukondo/slide-generation convert presentation.yaml
+```
+
+**Requirements:** Node.js >= 22.0.0
+
+## Quick Start
+
+```bash
+# Initialize a new project
+slide-gen init my-presentation
+cd my-presentation
+
+# Edit presentation.yaml, then convert
+slide-gen convert presentation.yaml
+
+# Watch for changes
+slide-gen watch presentation.yaml
+
+# Preview with Marp CLI
+marp --preview presentation.md
+```
+
+## Source File Format
+
+```yaml
+meta:
+  title: My Presentation
+  author: Your Name
+  date: "2024-03-15"
+  theme: default
+
+slides:
+  - template: title
+    content:
+      title: Welcome
+      subtitle: Getting Started
+      author: Your Name
+
+  - template: bullet-list
+    content:
+      title: Key Points
+      items:
+        - First important point
+        - Second important point
+        - Third important point
+
+  - template: section
+    content:
+      title: Next Section
+```
+
+## Commands
+
+### convert
+
+Convert YAML source to Marp Markdown.
+
+```bash
+slide-gen convert <input> [options]
+```
+
+Options:
+- `-o, --output <path>` - Output file path (default: `<input>.md`)
+- `-c, --config <path>` - Config file path
+- `-t, --theme <name>` - Theme name
+- `--no-references` - Disable reference processing
+- `-v, --verbose` - Verbose output
+
+### validate
+
+Validate source file without conversion.
+
+```bash
+slide-gen validate <input> [options]
+```
+
+Options:
+- `--strict` - Treat warnings as errors
+- `--format <fmt>` - Output format (text/json)
+
+### watch
+
+Watch file and auto-convert on changes.
+
+```bash
+slide-gen watch <input> [options]
+```
+
+Options:
+- `-o, --output <path>` - Output file path
+- `--debounce <ms>` - Debounce delay (default: 300)
+
+### templates
+
+List and inspect available templates.
+
+```bash
+# List all templates
+slide-gen templates list
+
+# Show template details
+slide-gen templates info <name>
+
+# Export example YAML
+slide-gen templates example <name>
+```
+
+### icons
+
+Search and preview icons.
+
+```bash
+# List icon sources
+slide-gen icons list
+
+# Search icons
+slide-gen icons search <query>
+
+# Preview icon
+slide-gen icons preview <name>
+```
+
+### init
+
+Initialize a new project.
+
+```bash
+slide-gen init [directory]
+```
+
+### preview
+
+Preview with Marp CLI (requires @marp-team/marp-cli).
+
+```bash
+slide-gen preview <input> [options]
+```
+
+## Available Templates
+
+### Basic
+- `title` - Title slide
+- `section` - Section divider
+- `bullet-list` - Bullet point list
+- `numbered-list` - Numbered list
+
+### Diagrams
+- `flow-chart` - Flow chart
+- `cycle-diagram` - Cycle diagram (3-6 elements)
+- `hierarchy` - Hierarchy/org chart
+- `matrix` - 2x2 matrix
+- `timeline` - Timeline
+
+### Data
+- `table` - Basic table
+- `comparison-table` - Comparison table with highlighting
+
+### Layouts
+- `two-column` - Two column layout
+- `three-column` - Three column layout
+- `image-text` - Image with text
+- `gallery` - Image gallery
+
+### Special
+- `quote` - Quote/citation slide
+- `code-block` - Code block with syntax highlighting
+- `bibliography` - Bibliography/references slide
+- `custom` - Custom Markdown slide
+
+## Configuration
+
+Create `config.yaml` in your project:
+
+```yaml
+templates:
+  builtin: "./templates"
+  custom: "./my-templates"
+
+icons:
+  registry: "./icons/registry.yaml"
+  cache:
+    enabled: true
+    ttl: 86400
+
+references:
+  enabled: true
+  connection:
+    type: cli
+    command: "ref"
+
+output:
+  theme: "default"
+```
+
+Config file search order:
+1. `--config` option
+2. `./config.yaml`
+3. `./slide-gen.yaml`
+4. `~/.slide-gen/config.yaml`
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Development mode
+pnpm dev
+
+# Build
+pnpm build
+
+# Test
+pnpm test
+
+# Lint
+pnpm lint
+
+# Type check
+pnpm typecheck
+```
+
+## License
+
+MIT

package/README_ja.md

@@ -0,0 +1,248 @@
+# slide-generation
+
+YAMLソースファイルからMarp対応Markdownを生成するCLIツールです。人間とAIの両方がプレゼンテーションを簡単に作成できるように設計されています。
+
+## 特徴
+
+- **YAMLベースのソースファイル** - 構造化され、可読性が高く、プログラムからの生成も容易
+- **テンプレートシステム** - 様々なスライドタイプに対応した再利用可能なテンプレート
+- **アイコンサポート** - Material Icons、Heroicons、カスタムアイコンに対応した組み込みアイコンレジストリ
+- **文献管理連携** - reference-manager CLIとの連携による引用管理
+- **監視モード** - ファイル変更時の自動変換
+- **Marp互換** - 出力はMarp CLIでそのまま使用可能
+
+## インストール
+
+```bash
+# npmを使用
+npm install -g @ncukondo/slide-generation
+
+# pnpmを使用
+pnpm add -g @ncukondo/slide-generation
+
+# npxで直接実行
+npx @ncukondo/slide-generation convert presentation.yaml
+```
+
+**動作要件:** Node.js >= 22.0.0
+
+## クイックスタート
+
+```bash
+# 新規プロジェクトを初期化
+slide-gen init my-presentation
+cd my-presentation
+
+# presentation.yamlを編集後、変換
+slide-gen convert presentation.yaml
+
+# ファイル変更を監視
+slide-gen watch presentation.yaml
+
+# Marp CLIでプレビュー
+marp --preview presentation.md
+```
+
+## ソースファイル形式
+
+```yaml
+meta:
+  title: プレゼンテーション
+  author: 作成者名
+  date: "2024-03-15"
+  theme: default
+
+slides:
+  - template: title
+    content:
+      title: ようこそ
+      subtitle: はじめに
+      author: 作成者名
+
+  - template: bullet-list
+    content:
+      title: 重要なポイント
+      items:
+        - 第一のポイント
+        - 第二のポイント
+        - 第三のポイント
+
+  - template: section
+    content:
+      title: 次のセクション
+```
+
+## コマンド
+
+### convert
+
+YAMLソースをMarp Markdownに変換します。
+
+```bash
+slide-gen convert <input> [options]
+```
+
+オプション:
+- `-o, --output <path>` - 出力ファイルパス（デフォルト: `<input>.md`）
+- `-c, --config <path>` - 設定ファイルパス
+- `-t, --theme <name>` - テーマ名
+- `--no-references` - 引用処理を無効化
+- `-v, --verbose` - 詳細出力
+
+### validate
+
+変換せずにソースファイルを検証します。
+
+```bash
+slide-gen validate <input> [options]
+```
+
+オプション:
+- `--strict` - 警告もエラーとして扱う
+- `--format <fmt>` - 出力形式（text/json）
+
+### watch
+
+ファイルを監視して変更時に自動変換します。
+
+```bash
+slide-gen watch <input> [options]
+```
+
+オプション:
+- `-o, --output <path>` - 出力ファイルパス
+- `--debounce <ms>` - デバウンス遅延（デフォルト: 300）
+
+### templates
+
+利用可能なテンプレートの一覧表示と詳細確認を行います。
+
+```bash
+# 全テンプレートを一覧表示
+slide-gen templates list
+
+# テンプレートの詳細を表示
+slide-gen templates info <name>
+
+# サンプルYAMLを出力
+slide-gen templates example <name>
+```
+
+### icons
+
+アイコンの検索とプレビューを行います。
+
+```bash
+# アイコンソースを一覧表示
+slide-gen icons list
+
+# アイコンを検索
+slide-gen icons search <query>
+
+# アイコンをプレビュー
+slide-gen icons preview <name>
+```
+
+### init
+
+新規プロジェクトを初期化します。
+
+```bash
+slide-gen init [directory]
+```
+
+### preview
+
+Marp CLIでプレビューを表示します（@marp-team/marp-cliが必要）。
+
+```bash
+slide-gen preview <input> [options]
+```
+
+## 利用可能なテンプレート
+
+### 基本（Basic）
+- `title` - タイトルスライド
+- `section` - セクション区切り
+- `bullet-list` - 箇条書きリスト
+- `numbered-list` - 番号付きリスト
+
+### 図表（Diagrams）
+- `flow-chart` - フローチャート
+- `cycle-diagram` - 循環図（3〜6要素）
+- `hierarchy` - 階層図・組織図
+- `matrix` - 2x2マトリクス
+- `timeline` - タイムライン
+
+### データ（Data）
+- `table` - 基本テーブル
+- `comparison-table` - 比較表（強調表示付き）
+
+### レイアウト（Layouts）
+- `two-column` - 2カラムレイアウト
+- `three-column` - 3カラムレイアウト
+- `image-text` - 画像とテキスト
+- `gallery` - 画像ギャラリー
+
+### 特殊（Special）
+- `quote` - 引用スライド
+- `code-block` - コードブロック（シンタックスハイライト付き）
+- `bibliography` - 参考文献スライド
+- `custom` - カスタムMarkdownスライド
+
+## 設定
+
+プロジェクトに `config.yaml` を作成します:
+
+```yaml
+templates:
+  builtin: "./templates"
+  custom: "./my-templates"
+
+icons:
+  registry: "./icons/registry.yaml"
+  cache:
+    enabled: true
+    ttl: 86400
+
+references:
+  enabled: true
+  connection:
+    type: cli
+    command: "ref"
+
+output:
+  theme: "default"
+```
+
+設定ファイルの検索順序:
+1. `--config` オプションで指定されたパス
+2. `./config.yaml`
+3. `./slide-gen.yaml`
+4. `~/.slide-gen/config.yaml`
+
+## 開発
+
+```bash
+# 依存パッケージをインストール
+pnpm install
+
+# 開発モード
+pnpm dev
+
+# ビルド
+pnpm build
+
+# テスト
+pnpm test
+
+# リント
+pnpm lint
+
+# 型チェック
+pnpm typecheck
+```
+
+## ライセンス
+
+MIT

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node