READMEの使い方

3066 ワード
プログラミング勉強日記 GitHub Readme GitHub テキストリンク

プログラミングの勉強日記

2020年6月5日　Progate Lv.83
ウェブページ制作中
READMEを作ってみた

READMEとは

　説明書みたいなもの。ソースコードをみる前にREADMEを見てもらうことで、概要を掴んでもらう。

GitHubでの作成方法

　GitHubでは簡単にREADMEを作成することができる。

①リポジトリを作成する。
②リポジトリの作成後画面を開いてAdd a READMEをクリックする。

③ファイルの編集画面が開くのでファイルを編集して、Commit a new fileをクリックする。

④READMEが作成される

⑤READMEを編集するときは鉛筆マークを押すと編集できる。

READMEの書き方

　READMEはマークダウン方式に沿って編集する。（Qiitaと同じ感じ）

改行を入れる

　行末に半角スペースを2回入れるか、<br>を使う。

例
改行をする␣␣
改行をする<br>

改行を入れる

　改行を開けるときは空行をあけるだけでいい。

例
1段落目

2段落目

強調する

　アスタリスクまたはアンダーバーで囲う。より強い強調をしたときは2つのアスタリスクまたはアンダーバーで囲う。

例
*強調* 
_強調_
**より強い強調** 
__より強い強調__

見出しを入れる

　見出しは「#+半角スペース+見出し名」の形で記述する。半角スペースを入れることに注意する。

例
# 見出し１(h1)
## 見出し２(h2)
### 見出し３(h3)
#### 見出し４(h4)

コードを表示する

　1行のコードはバッククォーテーション(Windowsの場合は「shift」+＠)で囲う。複数行のコードは半角スペースを4つ行の先頭に付ける。

例
`$('.prev').hide();`

␣␣␣␣$('.prev').hide();
␣␣␣␣$('.next').hide();

リンクを入れる

　[文章](リンク先のURL)を使う。