コンテンツにスキップ

エコシステム

本文書では,minitype を用いた文書作成を実現するエコシステムを紹介します.

@minitype/minitype は,TypeScript(JavaScript)のパッケージとして提供される組版処理エンジンです. 高度な組版機能をライブラリとして利用できるため,単体での利用に加えて,アプリケーションに組込んだり,生成 AI から利用したりと様々なワークフローでの文書生成が実現されます. 本パッケージは Node.js,Bun,およびブラウザ上で動作します.

使用方法については,クイックスタートを参照してください.

create-minitype は,minitype の文書プロジェクトをセットアップするツールです. コマンドラインまたは API 経由でテンプレートを選択して,必要なソースファイル一式を自動生成します. これにより,プロジェクトの初期設定を対話形式で行い,文書の用途に応じたテンプレートを使用して文書作成を始められます.

create-minitype はオープンソースにて公開されています.使用方法については,create-minitype の README を参照してください.

@minitype/vite-plugin は,minitype の Vite プラグインです. 開発サーバ上でファイルの変更を検知して組版を自動実行し,ブラウザ上でリアルタイムプレビューを提供します. create-minitype を用いてプロジェクトをセットアップした場合,自動でインストールされます.

vite-plugin はオープンソースにて公開されています.使用方法については,vite-plugin の README を参照してください.

@minitype/tsx は,文書を JSX/TSX で記述するためのパッケージです. JSX ランタイム,ならびにブロック,インライン,および標準プラグインに対応するコンポーネント群を提供します. これにより,React や HTML に類似した記法で minitype の文書を記述することが可能になります.

@minitype/tsx はオープンソースにて公開されています. 使用方法については,tsx の README を参照してください.

各パッケージは以下のライセンスにて提供されます.

パッケージライセンス
@minitype/minitypePolyForm Noncommercial License 1.0.0
create-minitypeMIT License
@minitype/vite-pluginMIT License
@minitype/tsxMIT License

@minitype/minitype では,個人利用を含む非商用目的での利用は自由に行えますが,商用目的での利用,改変,および再配布は許可されていません.商用利用をご希望の場合は,別途お問い合わせください. 上記にかかわらず,個人またはサークルによる同人活動を目的とした利用は,成果物の有償頒布を伴う場合を含めて許可されます. なお,これらのソフトウェアを使用して生成した PDF や画像等の成果物自体には,本ライセンスは適用されません.