GitHubのためのPlantUML：GitHubで直接PlantUMLダイアグラムをレンダリング
GitHub 用の PlantUML は、PlantUML からのもので、ドキュメントおよびレビューのワークフローのために GitHub ページに PlantUML 図のプレビューを埋め込む Firefox 拡張機能です。これは、ブラウザ側エンジンを使用して PlantUML ソースをその場でレンダリングするため、貢献者は画像を手動でエクスポートする必要がありません。この拡張機能は GitHub テーマをサポートし、ソース/図のトグルを提供し、リポジトリインターフェース内で迅速かつプライベートな図のプレビューを必要とするソフトウェアアーキテクト、開発者、および技術ライターを対象としています。
ドキュメントとレビューのフローがどのように変わるか
拡張機能はドキュメントワークフローから手動エクスポートステップを削除します。これにより、コードレビューや執筆中の視覚的検証が迅速化され、図がインラインでレンダリングされます。これは、ディスカッションやGistsなどの追加のインターフェースを含むほとんどのリポジトリインターフェースで動作し、埋め込まれた図のためにGitHub自身のサンドボックスパターンを模倣し、レンダリングされたコンテンツが外部ビューアなしでMarkdownの横に視覚的に配置されます。
どの図の構文と形式を認識するか
サポートは標準のPlantUML図タイプとエイリアスをカバーします。したがって、シーケンス、クラス、およびアクティビティ図はそのネイティブテキストからレンダリングされます。拡張機能は「puml」や「wsd」などの言語エイリアスを受け入れ、GitHubのネイティブ構文ハイライトでテキストを表示するトグル可能なビューで元のソースを保持します。これにより、レビュアーは基礎となるモデルを直接検査またはコピーするのに役立ちます。
プライバシー、権限、およびパフォーマンスの取り扱い
レンダリングは外部サーバーやトラッキングを避けるように設計されています。ゼロトラッキング、ゼロサーバーアーキテクチャ、および必要なブラウザアクセスを最小限に抑えるゼロ権限哲学を使用しています。拡張機能はページコンテキスト内でローカルに実行され、同じアプローチが適用されるChromiumベースのブラウザとも互換性があります。ローカルレンダリングは、即座にその場で図を生成し、コミュニティのフィードバックで速いと報告されています。
個々の貢献者とプライバシーを重視するチームのための実用的な選択
PlantUML for GitHubは、図のデータをサードパーティサービスに送信することなく、迅速なリポジトリ内プレビューを望む開発者や文書作成者のための実用的なツールです。この点は、Firefoxアドオンストアでの高評価に反映されています。中央集権的なサーバーサイドの画像パイプラインやリポジトリホストされた画像アセットを必要とするチームにはあまり適していません。レビュアーは、視覚的チェックを短縮するためにウォークスルー中に拡張機能を有効にしてください。
