md-tech-pdf 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.ja.md

@@ -0,0 +1,330 @@
+# md-tech-pdf
+
+[English](./README.md) | 日本語
+
+Markdownで作成した技術文書を、高品質なPDFへ変換するオープンソースツールです。
+
+一般的なMarkdown PDF変換ツールとの差別化として、MermaidやPlantUMLなどのダイアグラム・図表をPDF向けに美しく、かつ柔軟にレイアウト・配置できることを目指しています。
+
+将来的にはVSCode Extensionとしての提供も予定していますが、PDF生成コアロジックはCLIや特定のエディタ環境に依存しない独立した「Coreライブラリ」として設計されています。
+
+---
+
+## 主な特徴
+
+- **Markdown → 高品質ベクターPDF**: Playwright Chromiumベースの高精度なレンダリングエンジン。
+- **Mermaid & PlantUML 対応**: フローチャート、シーケンス図、クラス図などを鮮明なベクターSVGとして埋め込み。
+- **柔軟なダイアグラム配置**: `width`, `height`, `fit` (contain / fill), `align` (left / center / right) による精密なサイズ・位置制御。
+- **YAML Front Matter**: 用紙サイズ（A4）、向き（縦/横）、余白（margin）、フォント等をドキュメント単位で一括定義。
+- **フォントカスタマイズ**: OSインストール済みのローカルフォントおよび Google Fonts のWebフォントを個別指定可能。
+- **印刷品質のレイアウト制御**: 見出しの孤立抑止（Orphan Heading対策）、超長行コードブロックの自動折り返し、多列テーブルの可読性最適化。
+- **使いやすいCLI**: 出力先指定、自動ディレクトリ作成、ヘルプ・バージョン表示をサポート。
+
+---
+
+## 前提環境 (Requirements)
+
+- **Node.js**: >= 20.0.0
+- **Playwright / Chromium**: PDFレンダリングに必要です（依存関係に含まれます）。
+- **Java ランタイム & PlantUML jar**: PlantUMLダイアグラムを描画する場合のみ必要です（Mermaidのみを使用する場合はJavaは不要です）。
+- **インターネット接続**: Google Fontsを利用する場合のみ必要です（オフライン時はシステムフォントへ自動フォールバックします）。
+
+---
+
+## インストール
+
+グローバルインストールしてCLIコマンドとして利用できます。
+
+```bash
+# npm を使用する場合
+npm install -g md-tech-pdf
+
+# pnpm を使用する場合
+pnpm add -g md-tech-pdf
+```
+
+また、インストールせずに `npx` で即座に実行することも可能です。
+
+```bash
+npx md-tech-pdf document.md -o output.pdf
+```
+
+---
+
+## クイックスタート & CLIの使い方
+
+### 基本コマンド
+
+Markdownファイルを指定してPDFへ変換します。
+
+```bash
+# 入力ファイルと同じディレクトリに document.pdf を生成
+md-tech-pdf document.md
+```
+
+### 出力先パスの指定
+
+`-o` または `--output` オプションで出力先PDFのファイルパスを指定できます。
+
+```bash
+md-tech-pdf document.md -o output.pdf
+```
+
+出力先ディレクトリが存在しない場合は、自動的に作成されます。
+
+```bash
+md-tech-pdf docs/architecture.md -o build/architecture.pdf
+```
+
+### ヘルプ・バージョン表示
+
+```bash
+# ヘルプの表示
+md-tech-pdf --help
+md-tech-pdf -h
+
+# バージョンの表示
+md-tech-pdf --version
+md-tech-pdf -v
+```
+
+---
+
+## ドキュメント設定とダイアグラム記述例
+
+### YAML Front Matter設定
+
+Markdownファイルの先頭にFront Matterを記述することで、文書全体のPDF余白や図の規定サイズを設定できます。
+
+```yaml
+---
+pdf:
+  format: A4
+  landscape: false
+  margin:
+    top: 20mm
+    right: 20mm
+    bottom: 20mm
+    left: 20mm
+
+diagram:
+  width: 120mm
+  height: 70mm
+  fit: contain
+  align: center
+
+style:
+  font:
+    family: 'Noto Sans JP'
+    codeFamily: 'Roboto Mono'
+    google:
+      families:
+        - name: 'Noto Sans JP'
+          weights: [400, 500, 700]
+        - name: 'Roboto Mono'
+          weights: [400, 700]
+---
+# システム構成書
+```
+
+### ダイアグラムの配置オプション
+
+MermaidおよびPlantUMLブロックでは、中括弧 `{}` を用いて図ごとの属性を指定できます。指定可能な属性は以下の通りです。
+
+- `width`: 幅の指定（単位: `mm`, `cm`, `in`, `px`, `pt`, `%`）
+- `height`: 高さの指定（単位: `mm`, `cm`, `in`, `px`, `pt`, `%`）
+- `fit`: リサイズ時の挙動（`contain`: アスペクト比を維持して収める / `fill`: 指定枠いっぱいに拡大縮小）
+- `align`: 配置位置（`left` / `center` / `right`）
+
+### Mermaidダイアグラム
+
+フェンスブロックで `mermaid` を指定します。レンダリングは高解像度なベクターSVGとして行われ、PDF拡大時も線が劣化しません。
+
+````markdown
+```mermaid {width=140mm align=center}
+graph TD
+  Client[クライアント] --> API[APIサーバー]
+  API --> DB[(データベース)]
+```
+````
+
+### PlantUMLダイアグラム
+
+フェンスブロックで `plantuml` を指定します。ローカルマシン上でJavaプロセスを直接起動してベクターSVGを生成するため、外部のPlantUMLサーバーへ社内機密情報や設計図が送信される心配はありません。
+
+````markdown
+```plantuml {width=100mm align=center}
+@startuml
+actor User
+participant Server
+User -> Server: リクエスト送信
+Server --> User: レスポンス返却
+@enduml
+```
+````
+
+> **注意 (PlantUMLの前提要件)**:
+> PlantUMLの描画には、ローカル環境に **Javaランタイム** および **PlantUMLのjarファイル** がインストールされている必要があります（Mermaidのみを使用する場合はJavaは不要です）。
+> 必要に応じて、Front Matterでjavaおよびjarのパスを明示指定できます。
+>
+> ```yaml
+> plantuml:
+>   javaPath: '/usr/bin/java'
+>   jarPath: '/path/to/plantuml.jar'
+> ```
+
+### フォント設定 (style.font)
+
+文書の本文フォント（`family`）およびコードブロックフォント（`codeFamily`）を指定できます。
+
+#### 1. ローカルフォントの指定
+
+OSにインストールされているフォントを指定します。外部通信を行わずに高速かつオフラインで利用できます（実行環境に対象フォントがインストールされている必要があります）。
+
+```yaml
+style:
+  font:
+    family: 'Hiragino Sans'
+    codeFamily: 'Menlo'
+```
+
+- 本文フォントのフォールバックとして自動的に `sans-serif` が付与されます。
+- コード用フォント（`code`, `pre`）のフォールバックとして自動的に `monospace` が付与されます。
+
+#### 2. Google Fonts の指定
+
+Google Fonts CSS2 APIを利用してWebフォントを読み込み、本文およびコードフォントとして適用します（生成時に外部ネットワークアクセスが必要です）。
+
+```yaml
+style:
+  font:
+    family: 'Noto Sans JP'
+    codeFamily: 'Roboto Mono'
+    google:
+      families:
+        - name: 'Noto Sans JP'
+          weights: [400, 500, 700]
+        - name: 'Roboto Mono'
+          weights: [400, 700]
+```
+
+- `weights` には `100, 200, 300, 400, 500, 600, 700, 800, 900` の標準weightを指定できます。
+- PDF生成時は `document.fonts.ready` によりWebフォントのロード完了を待機してからレンダリングが行われます。
+- オフライン時や通信障害時はタイムアウト後にフォールバックフォントを用いてPDF生成を継続します。
+
+---
+
+## アーキテクチャ概要
+
+本プロジェクトは関心事の分離を重視し、UI層（CLI、将来のエディタ拡張）とコアエンジン層を明確に分離しています。
+
+### レイヤー構造
+
+```text
++---------------------------------------+
+|             Client Layer              |
+|  +----------------+ +---------------+ |
+|  |      CLI       | |  VSCode Ext   | |
+|  |  (src/cli)     | |   (Future)    | |
+|  +-------+--------+ +-------+-------+ |
++----------|------------------|---------+
+           | (thin wrapper)   |
+           v                  v
++---------------------------------------+
+|              Core Layer               |
+|            (src/index.ts)             |
+|  - Markdown Parser                    |
+|  - Diagram Engine (Mermaid/PlantUML)  |
+|  - Layout Engine & PDF Generator      |
++---------------------------------------+
+```
+
+- **CLI (`src/cli/index.ts`)**: コマンドライン引数のパースとCore APIの呼び出しのみを担当します。PDF生成ロジックは記述しません。
+- **Core (`src/index.ts`)**: ドキュメント解析、図のレンダリング、レイアウト調整、PDF出力など、すべての生成ロジックを集約する独立ライブラリです。
+
+### ディレクトリ構成
+
+```text
+md-tech-pdf/
+├── .github/          # GitHub Actionsワークフローおよびテンプレート
+├── docs/             # 設計資料・ドキュメント
+├── examples/         # サンプルMarkdown文書・設定例
+├── generated/        # 生成時の一時ファイル・出力先（.gitignore対象）
+├── src/              # ソースコード
+│   ├── cli/          # CLIエントリーポイント
+│   └── index.ts      # Coreライブラリ エントリーポイント
+├── test/             # テストコード
+├── CHANGELOG.md      # リリース履歴
+├── CODE_OF_CONDUCT.md# 行動規範
+├── CONTRIBUTING.md   # コントリビューションガイド
+├── LICENSE           # Apache-2.0 ライセンス
+├── README.md         # 英語版README
+├── README.ja.md      # 日本語版README
+├── package.json      # プロジェクト定義・依存関係
+├── tsconfig.json     # TypeScriptコンパイラ設定
+└── vitest.config.ts  # Vitestテストフレームワーク設定
+```
+
+---
+
+## 開発方法
+
+### 前提環境
+
+- Node.js >= 20.0.0
+- pnpm >= 9.0.0
+
+### セットアップ
+
+```bash
+# 依存関係のインストール
+pnpm install
+```
+
+### スクリプト一覧
+
+```bash
+# TypeScriptのビルド (dist/ へ出力)
+pnpm build
+
+# Vitestによるユニットテストの実行
+pnpm test
+
+# ESLintによる静的解析
+pnpm lint
+
+# Prettierによるコードフォーマットチェック
+pnpm format:check
+
+# Prettierによるコード整形
+pnpm format
+```
+
+---
+
+## 既知の制約事項 (Known Limitations)
+
+v0.1.0 リリース時点で把握されている仕様および制約事項です。
+
+1. **ページまたぎテーブルでのヘッダー再描画 (`<thead>`)**: 行数の多い表が改ページされる際、2ページ目以降の先頭にテーブルヘッダーは自動再描画されません（実用上のデータ読解は可能です）。
+2. **縦長ダイアグラム直前の余白**: 高さが150mmを超える縦長ダイアグラムは、途中で切断されるのを防ぐ安全策（`break-inside: avoid`）により次ページに送られるため、前ページ下部に空白が生じる場合があります。
+3. **PlantUMLの前提環境**: PlantUMLの描画にはローカルのJavaランタイムおよびPlantUML jarが必要です（Mermaidのみ使用する場合は不要です）。
+4. **Google Fontsのネットワーク要件**: Google Fontsの読み込みにはPDF生成時にインターネット接続が必要です（オフライン時や障害時はシステムフォントへ自動フォールバックします）。
+
+---
+
+## 変更履歴 (Changelog)
+
+各バージョンの詳細な変更内容については [CHANGELOG.md](./CHANGELOG.md) をご覧ください。
+
+---
+
+## コントリビューション (Contributing)
+
+バグ報告や機能提案、プルリクエストを歓迎します。開発への参加方法やガイドラインについては [CONTRIBUTING.md](./CONTRIBUTING.md) をご確認ください。また、コミュニティ参加にあたっては [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) の遵守をお願いいたします。
+
+---
+
+## ライセンス (License)
+
+本プロジェクトは [Apache License 2.0](./LICENSE) のもとで公開されています。