@minitype/minitype
v0.1.6
Published
Typesetting engine provided as a TypeScript package.
Maintainers
Readme
minitype
minitype は,TypeScript(JavaScript)のパッケージとして提供される組版処理エンジンです.
minitype is a typesetting engine served as a TypeScript (JavaScript) package.
minitype は以下の特徴を備えています.
- TypeScript ライブラリ
組版機能をライブラリとして提供するため,単体での利用に加えて,アプリケーションに組込んだり,生成 AI から利用したりと様々なワークフローでの文書生成が実現できます. - 高度な日本語組版
禁則処理,縦組,ルビ,ハイフネーション,段組,フロート等の高度な組版やレイアウトに必要な機能を備えています. - マルチプラットフォーム
Node.js,Bun といったサーバサイドの環境に加えて,標準的な Web ブラウザ上でも動作します.
使い方
minitype パッケージをインポートし,minitype 関数を実行します.
Hello World
import { h1, minitype, p } from "minitype";
await minitype(
[{
body: [
h1("Hello World!"),
p("minitype のテストです"),
],
}],
).save("hello.pdf");yarn add minitype
yarn run index.ts
bun add minitype
bun run index.tsまた,以下の周辺ツールを使用することができます.
- create-minitype:コマンドライン・インタフェース(CLI)または API 経由で,テンプレートを基にした minitype プロジェクトの作成,依存関係のインストールを行うツール
- @minitype/vite-plugin:リアルタイムプレビューを行う Vite プラグイン
minitype のクイックスタート,および仕様の詳細については,以下のドキュメントを参照してください.
ライセンス・謝辞
Copyright (c) 2026 Yuto Wada. This software is released under the PolyForm Noncommercial License 1.0.0, see LICENSE.
- 本ソフトウェアの個人利用を含む非商用目的での利用・改変・再配布は自由に行えますが,商用目的での利用は許可されていません.商用利用をご希望の場合は,別途お問い合わせください.
- 上記にかかわらず,個人またはサークルによる同人活動を目的とした利用は,成果物の有償頒布を伴う場合を含めて許可されます.
- 本ソフトウェアを使用して生成した PDF や画像等の成果物自体には,本ライセンスは適用されません.
本ソフトウェアは,2025 年度下期 未踏アドバンスト事業の支援を受けて開発されました.
本ソフトウェアはサードパーティのオープンソースパッケージを使用しています.
各パッケージのライセンスおよび著作権表示は THIRD_PARTY_LICENSES.txt を参照してください.
本ソフトウェアは hyphenation.en-us(著作権者:Bram Stein)を使用しています. 同パッケージは GNU Lesser General Public License (LGPL) の下で配布されています. LGPL の全文は https://www.gnu.org/licenses/lgpl.html を参照してください.
