GitHub(ギットハブ)のうち主に Git・Code 以外の機能についてまとめています。


目次

GitHub Pages は別途ページがあります。

🎈 GitHub Pages | ふうせん🎈 FU-SEN


公式サイト


スペシャルリポジトリ

🎈 fu-sen | GitHub

現在ページ運営者のプロフィールページです。
従来は Popular repositories として、主に ☆ Star や Fork が入っているリポジトリ、
自分で Pin を入れて特に見せたいリポジトリを表示する画面と、
最近の GitHub での活動情報が表示されていました。

2020 年より、ここに新機能が加わり、 任意の表示が可能になっています。

🎈 fu-sen/fu-sen | GitHub

ユーザー名と同じリポジトリを作成し、そのリポジトリに README.md を生成するだけです。
ページ運営差hは fu-sen なので、 fu-sen でリポジトリを生成しています。
これが special repository(スペシャルリポジトリ)となります。
リポジトリの一つなので、他のファイルも入れて使用でき、
🎈 GitHub Pages も有効にできます。

注意事項

 NAME is recognized instead of NAME.github.io #11448 | Github desktop/desktop issues

GitHub Pages で使用していた ユーザー名.github.io を ユーザー名 に変更すると
GitHub Desktop が不具合を起こす事が分かっています。。

以前から同じ原因と思われる報告があったのですが、再現できない状況だったようです。
ページ運営者が不具合を発生できるパターンを確定でき、報告しています。


GitHub Discussions

 GitHub Discussions | GitHub Docs

いわゆる掲示板です。フォーラム形式で、プロジェクトのタブとして表示されます。
従来は掲示板システムを別に設置したり、Issues が使われる事がありましたが、
Discussions でそのプロジェクトに関する利用者間交流ができるようになりました。

投稿形式はカテゴリにより、
「Open ended discussion」と「Question / Answer」があります。
「Question / Answer」の場合は理想的な回答に を付ける事ができます。

表示は英語ですが、日本語も問題なく使用できますし、絵文字 🎈 も使えます。

▲ Discussions | GitHub vercel/vercel

🎈Vercel は公開されてまもなく導入していました。
旧フォーラムから引き継がれ、特に活発な場所の一つとなっています。

🎈 Discussions | GitHub fu-sen/fu-sen

GitHub での活動が多かったあり、GitHub を使っている仲間が多いのであれば、
個人用途で設置するのも良いように思います。
GitHub Pages や スペシャルリポジトリ のプロジェクトが理想的でしょう。
Organization の場合、非公開のプロジェクトに設置して、特定者の内部用として使う事もできます。

Categories

デフォルトで次が設定されています。投稿時に選択します。

  • General - 関連する投稿。他のカテゴリに属さない内容
  • 🙏 Help または 🙏 Q&A - 関連する質問投稿と回答コメント
  • 💡 Ideas - 関連したアイデア・使い方などの共有
  • 🙌 Show and tell - 関連して制作・公開したものの公開

General 以外は変更・削除可能です。もちろん追加もできます。
この時必ず 🎈 絵文字を指定します。

Issues から Discussions へ移動

Issues に入った内容を Discussions の投稿へ移動する事ができます。
これにより、Issues は不具合報告の目的専門にして、
使い方などの質問は Disscussions に書き込んでもらう、と分ける事ができます。

Pin discusssion

管理者は特に見てほしい投稿について Pin discusssion を付ける事ができます。
付けた投稿は discusssions トップページのヘッダに表示されます。
はじめて見た時のあいさつや独自のルールなどを表示する時に便利でしょう。


Wiki

 ウィキについて | GitHub Docs

主に公開しているプロジェクトのドキュメント用途として使われるものです。
現在新規でプロジェクトを作成した場合はタブで Wiki が存在しているので、
選択して、すぐに作成をする事ができます。

Setting 内に Wiki 関連の設定があります。

  • Wiki - を外すとタブ非表示になります。
  • Restrict editing to collaborators only -
    を外すと GitHub にログインしている人が誰でも編集できるようになります。

Wiki は Web 画面上で編集も可能ですが、Git 管理の対象になっています。
専用の Git アドレスが存在します。(サイドバー下に表示されています)
ただし GitHub Desktop での使用は長く不具合が存在するので、
他の Git GUI を使用するのが無難そうです。

🎈 Wiki | GitHub fu-sen/fu-sen

ページ運営者の Wiki です。
このページを含む「複合コンテンツ」の英語版として使用しています。

Edit Mode

Edit Mode は次を選択できます。

  • AsciiDoc
  • Creole
  • Markdown
  • MediaWiki
  • Org-mode
  • Pod
  • RDoc
  • Textile
  • reStcturedText

デフォルトは 🎈 Markdown です。
現在プロジェクトの README は README.md を当たり前に採用しますし、
後に静的サイトジェネータへ移行する事も考えても Markdown が無難でしょう。

画像

編集ページから画像のドラッグ&ドロップは効きません。
Issues を開いてドラッグ&ドロップし、Markdown を貼り付けるのは有効です。
もちろんリポジトリの URL を貼り付ける事もできますが、
github.com 外のアドレスは、プロキシ動作で読み込みキャッシュします。
その時画像が Not Found だと、それをキャッシュしてしまうのでご注意下さい。

ページ名

 ウィキにフッタやサイドバーを作成する | GitHub Docs

次のページ名は特別な動作をします。

  • Home - Wiki トップページ(=真の「ホームページ」)になります。
  • _Footer - フッタ。全ページの下部に表示されます。
  • _Sidebar - サイドバー。作成するとページ一覧が縮まり、代わりに表示します。

その他注意事項

README もそうなのですが…… GitHub の固定表示で <h1> が使われていますので、
実際の文中では見出しを <h2> から使用するのが SEO 的に理想的でしょう。
Makrdown でいう ## です。


Organizations

 Organizationについて | GitHub Docs

Organization を作成すると GitHub Pages は
organization名.github.io を生成し、
そのサブディレクトリもプロジェクトで使用できます。
もちろんこれらに独自ドメインを使用する事も可能です。

法人など、複数人での使用で個人ユーザーとは別に生成できますが、
個人一人で Organizations を作成し、管理しても構いません。
特に有名なプロジェクトで複数のリポジトリ生成が必要な場合や、
個人ユーザーとは全く別の用途で管理したい場合に使えます。
これが可能なため、GitHub は個人の複数アカウント利用を推奨していません。

単にアカウント名を奪う目的での使用は禁じられています。
サポートに連絡すると、しばらく使っていないアカウントは削除し、
使用したい人・組織などがアカウントを使用する事ができます。


Social preview

GitHub プロジェクト の Settings - Social preview で
画像をアップロードしておくと、
GitHub プロジェクトを SNS へシェア(リンク)した場合に
🎈 Open Graph protocol(OGP)・Twitter Card を適用して、
画像を表示してくれるようになります。
GitHub Pages などで使用している画像があれば、同じ画像でも良いでしょう。

更に GitHub の検索結果でもこの画像は適用して表示されます。
使用しているプロジェクトがまだ少ないようで、
検索結果によっては特に目立って表示される状況になります。

推奨は 1280✕640 ピクセルとありますが、SNS によって最適な大きさが異なるので、
一部欠けて表示される場合があります。


Q&A

GitHub の運営はどこですか?

GitHub, Inc. がアメリカ カリフォルニア州サンフランシスコに拠点を置きます。
日本支社(ギットハブ・ジャパン合同会社)も存在します。

A bright future for GitHub | The GitHub Blog
Microsoft to acquire GitHub for $7.5 billion | Microsoft Stories

2016年にマイクロソフトが買収していますが、
独立した組織として運営を続けているようです。

Web 上では英語表示ですが、コメントなどは英語必須ですか?

いいえ。日本語で公開されいるリポジトリであれば、
日本語での issues・pull requests を行っても問題ありません。
日本語も正常に表示されますし、絵文字 🎈 も使えます。

ただし、git push など、海外の人も利用が想定されるコードなどは
少しでもコメントを英語にしておくと無難かと思います。

英語のプロジェクトであれば、基本的に英語で行うべきです。
ただし日本語関連の不具合であれば、文中に日本語を含めた説明をしても良いでしょう。

Wiki などの画像はどうするのですか?

Wiki は 🎈 GitHub Pages などで表示できる URL で
表示させている事が多いようです。

また、コメントでは、画像をドラッグ&ドロップするとアップロードされ、
自動的に表示される URL として生成される機能があります。Issues などで使用できます。
ただし、これを行った画像はその編集でリンクを外す事ができても、
物理的に画像ファイルを削除できなくなる事にご注意下さい。

GitHub で使われているキャラクターの名前は?

 Octodex

Octocat と言います。octopoda(🐙 タコ)+cat(😺 猫) ですね。
ただし、これはみんなが呼んでいる通称で、実名は違うようですよ。