share-pretty-gist

Share Pretty Gist

コンテンツを美しく表示される GitHub Gist としてまとめ、gists.sh で共有します。

使用する場面

ユーザーが単に保存するのではなく、ほかの人とコンテンツを共有したい場合にこのスキルを使用します。たとえば、次のような依頼が該当します。

• 「これを gist として共有して」
• 「このコード／レポート／ドキュメントの共有リンクを作って」
• 「誰かが読めるようにまとめて」
• 「これを [person] に gist として送って」
• 表示や読みやすさを重視した gist の作成依頼

これは、コンテンツが gists.sh 上で美しく表示されるように構成することを重視している点で、単純な gist の作成（保存）とは異なります。

ワークフロー

ステップ 1：コンテンツを準備する

会話の文脈から、ユーザーが共有したい内容を推測します。適切な構成を判断してください。

• コード：適切な拡張子が付いた正しいファイル名（例：server.ts、config.yml、query.sql）を使い、Shiki で正しくハイライトされるようにします。読者の理解に役立つ場合は、簡単なコメントヘッダーを追加します。
• レポート／ドキュメント：.md ファイルを使います。わかりやすい見出し、箇条書き、必要に応じて GFM アラートを使って構成します。
• チュートリアル／ガイド：.md ファイルを使います。番号付きの手順、言語タグ付きのコードブロック、補足には > [!TIP] ／ > [!NOTE] アラートを使います。
• 簡単な共有（スニペット、エラーログ、設定）：内容に最も適した拡張子を使います。最小限にまとめます。

複数ファイルの gist では、最も重要なファイルを先頭に配置します（gists.sh では最初のタブとしてデフォルト表示されます）。

共有したい具体的なテキストや Markdown の内容が文脈から明らかな場合は、必要に応じてごくわずかな書式調整を行うだけにして、内容をそのまま gist に入れます。

「{user name} が共有してほしいと言った内容です……」のようなメタコメントを gist の内容に絶対に含めないでください。

ステップ 2：gist を作成する

gh gist create <files> -d "Clear description of what this contains"

-d の説明文は gists.sh のタイトルになるため、内容が伝わる役立つものにします。

gh が利用できない場合や認証されていない場合は、インストールとセットアップの方法を案内します。

ステップ 3：キャッシュを温める

gist の作成後、読者がすぐにページを表示できるよう、gists.sh のページを一度取得してキャッシュを温めます。

curl -s https://gists.sh/{user}/{id} > /dev/null

ステップ 4：URL を提示する

主な共有リンクとして gists.sh を表示します。

-> https://gists.sh/{user}/{id}

(original on GitHub: https://gist.github.com/{user}/{id})

ルール

• 必ず SECRET gist を作成してください。「誰かと共有して」や「外部と共有して」と頼まれた場合でも、gist は必ず secret にします。ユーザーが公開 gist を明示的に求めた場合に限り、--public を使います。
• **必ず -d を含めてください。**明確で簡潔、かつ内容が伝わるタイトルにします。これは gists.sh で読者が最初に目にするものです。
• 適切な拡張子が付いた正しいファイル名（例：server.ts、config.yml、Dockerfile）を使い、構文ハイライトが正しく機能するようにします。
• 自然で内容が伝わるファイル名を使います。「gist-」や「shared-」のような不要な語をファイル名の先頭に付けないでください（例：gist-readme.md ではなく README.md、gist-setup-guide.md ではなく setup-guide.md を使います）。
• gist の作成後や更新後は、必ずキャッシュを温めてください。
• 元の共有コンテンツに含まれている場合を除き、コンテンツ内でエムダッシュを使わないようにしてください。
• メタコメントは禁止です（「ユーザーから依頼された内容は……」「以下に概要を示します……」など）。すぐに内容を始めてください。
• 作成者ではなく読者に向けて書きます。リンクを開いた人が、元の会話の文脈を知らなくても内容を理解できるようにします。

gists.sh のレンダリングのヒント

• 適切なシンタックスハイライトを適用するため、すべてのコードブロックに言語タグ（```typescript、```yaml など）を付けるようにしてください。
• GFM のアラートもきれいに表示されるため、使用できます：> [!NOTE]、> [!TIP]、> [!IMPORTANT]、> [!WARNING]、> [!CAUTION]。
• どうしても必要な場合を除き、生の HTML は避けてください。標準の GitHub Flavored Markdown を使用してください。
• 複数ファイルの gist は gists.sh でタブとして表示されます。デフォルトでは最初のファイルが表示されます。
• テーブル、タスクリストなど、GFM の機能はすべて使用できます。
• Markdown ファイルの YAML フロントマターは、コンテンツの上に構造化されたテーブルとして表示されます。
• 構造化データファイルにはインタラクティブなビューアーが用意されています：JSON/GeoJSON（折りたたみ可能なツリー）、YAML（ツリー）、CSV/TSV（並べ替え可能なテーブル）、ICS/iCal（カレンダーカード）。ビューアーを有効にするには、適切なファイル拡張子を使用してください。
• 複数ファイルの gist 内の特定のファイルには、?file={filename} を付けてリンクしてください。

既存の Gist の更新

以前に共有した gist を更新する場合：

1. gh gist edit {id} で gist を編集します
2. キャッシュの古いデータを無効にするため、更新エンドポイントに POST します。パージリクエストの間隔は 1 分です：

   curl -s -X POST https://gists.sh/{user}/{id}/refresh
   

3. 更新後のコンテンツでキャッシュをウォームアップします：

   curl -s https://gists.sh/{user}/{id} > /dev/null
   

表示パラメーター

ユーザーが特定の表示スタイルを明示的に希望した場合にのみ、これらを提案してください。パラメーターなしのデフォルト URL が推奨されます。

• ?theme=dark / ?theme=light -- ダークモードまたはライトモードを強制
• ?noheader -- タイトル、タブ、コピーボタンを非表示
• ?nofooter -- 作成者情報とフッターを非表示
• ?mono -- すべてのテキストに等幅フォントを使用
• ?file={filename} -- 複数ファイルの gist から特定のファイルを表示

パラメーターは組み合わせて使用できます：gists.sh/{user}/{id}?theme=dark&noheader&nofooter