Edited at

GitHubでテキストドキュメントを公開する

More than 5 years have passed since last update.

こちらの ゆめみスタッフブログ にも書きましたが、Qiitaにも投稿します。




GitHubは、プログラムのソースを公開するだけでなく、テキストドキュメントを置くことができます。

例えば、こういうものです ⇒ https://github.com/hkusu/github_document_demo/blob/master/README.md

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


必要なもの


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

とくに決まりはないのですが、こういう構成がいいんじゃないかというものです。

(ボリュームがなければ README.md ひとつだけでもいいと思います。)

リポジトリTOP


├ README.md .. 目次を書く

├ ○○.md
├ ○○.md
├ ○○.md

├ 第1章 .. フォルダを作成
│ ├ ○○.md
│ ├ ○○.md
│ └ ○○.md

├ 第2章 .. フォルダを作成

  ~

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


ドキュメントの記法

Qiitaのマークダウン記法がそのまま使えるので、ここでは割愛します^^;


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


  • 適当にファイルを ○○.md として作成してコミット&プッシュします。

  • リンクを張りたい場合は



    • [リンク名](○○.md) と記載します。



  • フォルダ作って階層を分けてもOKです。



    • [リンク名](△△/○○.md) と記載します。



  • 日本語のフォルダ名、ファイル名も使えます。


画像を張る


  • まず利用する画像もこのリポジトリにコミット&プッシュしておきます。


    • 仮に images フォルダに格納するとします。



  • こういう風にリンクを張ります。


    • ![alt内容(マウスカーソルが当たったときの表示テキスト)](images/○○.jpg)




ほか


おわりに

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