create-minitype

minitype の文書プロジェクトをセットアップするツールです． コマンドラインまたは API 経由でテンプレートを選択して，必要なソースファイル一式を自動生成します．

create-minitype is a tool to set up the documentation project for minitype. Users can select a template via the command line or API to automatically generate all the necessary source files.

テンプレート – 開発ガイド

コマンドラインから使用する

コマンドラインインタフェース（CLI）から実行する場合，以下のコマンドを実行します．

# npm
npm create minitype@latest [project-name] -- [options]

# Yarn
yarn create minitype [project-name] [options]

オプション

| オプション | 短縮形 | 説明 | | --- | --- | --- | | --template <name> | -t | 使用するテンプレート（省略した場合プロンプトで選択） | | --yes | -y | プロンプトをスキップ（--template と併用） | | --json | -j | 結果を JSON で出力（AI エージェント向け） | | --markdown | | Markdown からドキュメントを生成 | | --yaml | | YAML からドキュメントを生成 | | --pm <npm\|yarn> | | 依存関係のインストールに使用するパッケージマネージャ | | --list-templates | | 使用可能なテンプレート一覧を表示 | | --help | -h | ヘルプを表示 |

--json を指定した場合には対話プロンプトが省略され，生成結果だけが JSON として標準出力に出力されます． 診断情報や git 等の外部コマンドの出力は，標準エラー出力へ送られます．

使用例

# プロジェクト名を指定して対話形式で実行
npm create minitype@latest my-report

# テンプレートを指定して非対話で実行
npm create minitype@latest my-report -- --template report --yes

# Markdown モードで report テンプレートを生成し，依存関係もインストール
npm create minitype@latest my-report -- --template report --markdown --pm npm

# JSON 出力（CI，AIエージェント向け）
npm create minitype@latest my-report -- --template report --json

API 経由で使用する

Node.js スクリプトや AI エージェントから API 経由で使用する場合，以下の手順で実行します．

npm install create-minitype

import { createProject } from "create-minitype";

const result = await createProject({
  projectName: "my-report",
  templateId: "report",
  templateOptions: { markdown: true },
  packageManager: "yarn",
});

console.log(result.files); // 生成されたファイル一覧

createProject(options)

| フィールド | 型 | 説明 | | --- | --- | --- | | projectName | string | プロジェクト名（サブディレクトリ名になる） | | templateId | string | テンプレート ID，git URL，またはローカルパス | | templateOptions? | TemplateOptions | テンプレート固有のオプション | | packageManager? | "npm" \| "yarn" | 依存関係インストールに使用するパッケージマネージャ（省略時はスキップ） | | outputDir? | string | プロジェクトを作成するディレクトリ（省略時はカレントディレクトリ） | | json? | boolean | 結果を JSON で stdout に出力するか |

戻り値は CreateProjectResult（projectName，templateId，targetDir，files を持つオブジェクト）です．

生成されるプロジェクト構成

<project-name>/
├── src/
│   ├── index.ts       # スタイル，レイアウト定義
│   └── document.ts    # ドキュメントの内容（テンプレートによっては .md / .yaml）
├── fonts/             # 使用フォント（自動コピー）
├── vite.config.ts
├── tsconfig.json
├── package.json
└── README.md

生成されたプロジェクトに対しては，以下のコマンドで文書のビルドを実行できます．

cd <project-name>
npm install   # または yarn
npm run build # output.pdf が生成される

ライセンス・謝辞

Copyright (c) 2026 Yuto Wada. This software is released under the MIT License, see LICENSE.

本ソフトウェアは，2025 年度下期 未踏アドバンスト事業の支援を受けて開発されました．

• 未踏アドバンスト事業：2025年度下期実施プロジェクト概要（和田PJ）