GitHub ブロック: Markdown ファイル内の JavaScript コード。

最近の GitHub Universe イベントでの静かな発表の 1 つは GitHub Blocks で、VP Strategy の Kyle Daigle によって実験として提示されましたが、このプロジェクトは開発者が待機リストにサインアップできるほど十分に進んでいます。

ブロックを使用すると、開発者は JavaScript をリポジトリ ファイルに含めることができるため、リポジトリ ファイルがライブ ドキュメントになり、コンテンツの視覚化やリポジトリに関連する分析の提示などを行うことができます。Daigle 氏は、これを「レポジトリと直接かつインタラクティブにやり取りする方法」と説明しています。

このアイデアは、主により豊富なドキュメントを目的として提示されました。「ブロックは、コンテンツとの対話方法をカスタマイズするコンポーネントです」とユニバースの Daigle 氏は述べ、ブロックは「WYSIWYG エディターのライブ コード サンドボックスと同じくらい強力になる可能性がある」と付け加えました。リポジトリ自体の中で、リポジトリ内のコードが何をするか。Daigle 氏によると、Blocks は「GitHub にプッシュしてデプロイする小さなアプリ」と考えることができます。

GitHub リポジトリのドキュメントは、ほとんどの場合、Markdown でフォーマットされています。Markdown は、プレーン テキストとして簡単に作成して読みやすくすることを目的としたマークアップを追加する簡単な方法であり、見出し、リスト、画像、コード例などの重要なフォーマットも提供します。

Markdown にはさまざまなバリエーションがあり、Markdown のスーパーセットであるGFM (GitHub Flavored Markdown) と呼ばれる GitHub のバージョンがここで指定されています。

JavaScript を Markdown に追加するという概念は、Markdown の概念とはやや反対ですが、その考えは新しいものではありません。GitHub ブロックは、コーダーが R 言語コードと Shiny ウィジェットを埋め込むことができる R Markdown を連想させます。Shinyは、 JavaScript 、HTML、および CSS を実行するコンポーネントです。

Daigle が提示するユース ケースには、フォントと色のレンダリング、書式設定されたテーブルでの JSON データの表示、寄稿者などのリポジトリ分析の表示、問題の統計、コミットとプル リクエスト、図の表示、アプリケーション機能の動的なデモが含まれます。この最後の機能は、よくあることですが、それ自体が JavaScript または TypeScript でコーディングされているアプリケーションに最適です。もう 1 つの可能性は、ドキュメント内からコード検索とインデックス作成を生成することです。

GitHub にはすでに REST API があり、ある意味では、Blocks はこれを、JavaScript と HTML を GFM からレンダリングできるようにするというアイデアと組み合わせただけです。概念的には、リポジトリはコード用であり、コードのコンパイルと実行は別の場所で行われるという概念を混乱させます。この場合、コードはリポジトリから直接実行されるためです。

ブロックは GitHub 固有の機能であり、開発者がこれに依存すると、別のコード リポジトリへの切り替えが難しくなります。これは、実験のもう 1 つの側面であり、GitHub に利益をもたらす可能性があります。詳細とキャンセル待ちの申し込みはこちら.