• これはGitHubでドキュメントを公開するにはどうしたらいいか、というブログ記事用のデモリポジトリです。

GitHubは、プログラムのソースを公開するだけでなく、テキストドキュメントを置くことができます。 プログラマの方でなくても手順やガイドラインなどを公開したり、またドキュメントを複数人で書いたりバージョン管理するのに活用できます。

必要なもの

リポジトリ内のファイルの構成

とくに決まりはないのですが、こういう構成がいいんじゃないかというものです。 (ボリュームがなければ README.md ひとつだけでもいいと思います。)

リポジトリTOP
│
├ README.md .. 目次を書く
│
├ ○○.md
├ ○○.md
├ ○○.md
│
├ 第1章 .. フォルダを作成
│ ├ ○○.md
│ ├ ○○.md
│ └ ○○.md
│
├ 第2章 .. フォルダを作成

  ~

└ 画像用フォルダ .. 細分化してもよい
  ├ ○○.jpg
  ├ ○○.png
  └ ○○.xxx

ドキュメントの記法

① 見出し

  • 記法

     # 大タイトル
     ## 中タイトル
     ### 小タイトル
    
  • 結果


    大タイトル

    中タイトル

    小タイトル


② 箇条書き

  • 記法

     - 箇条書き
     	- タブでインテント
     		-  さらにタブでインテント
     - 箇条書き
     - 箇条書き
    
  • 結果


    • 箇条書き
      • タブでインテント
        • さらにタブでインテント
    • 箇条書き
    • 箇条書き

③ コード

  • 記法

    • 文中で利用する場合

      文文文[半角スペース]`コード`[半角スペース]文文文

    • 複数行の場合

       [空行]
       `を3つ
       コード
         ~
       コード
       `を3つ
       [空行]
      
  • 結果


    文文文 コード 文文文

     コード
       ~
     コード
    

④ 引用

  • 記法

     [空行]		
     > 引用したい文
     [空行]		
    
  • 結果


    引用したい文


ページを作ってリンクを張る

  • 適当にファイルを ○○.md として作成してコミット&プッシュします。
  • リンクを張りたい場合は
  • フォルダ作って階層を分けてもOKです。
    • [リンク名](△△/○○.md) と記載します。
    • こんな感じ → リンクテスト
  • 日本語のフォルダ名、ファイル名も使えます。

画像を張る

  • まず利用する画像もこのリポジトリにコミット&プッシュしておきます。
    • 仮に images フォルダに格納するとします。
  • こういう風にリンクを張ります。
    • ![alt内容(マウスカーソルが当たったときの表示テキスト)](images/○○.jpg)

    • こんな感じ↓

      alt内容

ほか

おわりに

最近はGitHubで小説を書いたりする人もいるようですね。本記事がGitHubの導入の参考になれば幸いです^^