いつもGitHubのREADME.mdの書き方を忘れてしまうので、備忘録を残しました。
目次
README.mdのMarkdown記法
良く使うものだけをピックアップしました。
見出し
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
- 先頭の#の数だけ繰り下がる
- #と文字列の間には半角空白が必要
段落
段落1
(空行)
段落2
(空行)
段落2
- 空白行を挟むことで段落となる
引用
> 引用
>> 多重引用
>> 多重引用
水平線
hoge
***
hoge
___
hoge
---
***
hoge
___
hoge
---
- アスタリスク"*"、アンダースコア"_"、 ハイフン"-"を3つ連続記述
箇条書きリスト
* リスト1
* リスト1_1
* リスト1_1_1
* リスト1_1_2
* リスト1_2
* リスト2
* リスト3
* リスト1_1
* リスト1_1_1
* リスト1_1_2
* リスト1_2
* リスト2
* リスト3
- アスタリスク"*"、プラス"+"、 ハイフン"-"のいずれかを先頭に記述
- 文字列の間には半角空白が必要
- ネストはタブで表現すること
リンク
[表示文字](URL)
強調
**ボールド**
__ボールド__
__ボールド__
- アスタリスク"*"、アンダースコア"_"のいずれかを2コで囲む
Images 画像
- 画像に変換されるので、文字列は何でもよい
表
| 左揃え | 中央揃え | 右揃え |
|:---|:---:|---:|
|1 |2 |3 |
|4 |5 |6 |
|:---|:---:|---:|
|1 |2 |3 |
|4 |5 |6 |
- Header部分の記述の仕方を変えることで、左揃え、中央揃え、右揃えを指定できる
README.mdの事前確認方法
GitHubにログインして、適当なファイルについてプレビューすればOK。
やり方は、以下のサイトを参考
README.mdの記載章について
自分が良く使っているテンプレを乗せておきます。
(あくまで例なので、好きなように変更してください。)
【公開しているSWの名称】
---
【概要(一目でわかるようなもの)】
# Description
【どうしてこれをつくったか、なにができるかを記述】
# Requirement
## Required device
【HW的に必要なものを記述】
## Required software
【SW的に必要なものを記述(コンパイラやライブラリとか)】
## Included software
【公開されているSWの中に含まれているライブラリとか】
# Usage
### 1.XXXX
### 2.YYYY
【使い方を番号ふって記載】
# Licence
【ライセンスをリンク】
# Author
【自分のGitHubのアカウントをリンク】
---
【概要(一目でわかるようなもの)】
# Description
【どうしてこれをつくったか、なにができるかを記述】
# Requirement
## Required device
【HW的に必要なものを記述】
## Required software
【SW的に必要なものを記述(コンパイラやライブラリとか)】
## Included software
【公開されているSWの中に含まれているライブラリとか】
# Usage
### 1.XXXX
### 2.YYYY
【使い方を番号ふって記載】
# Licence
【ライセンスをリンク】
# Author
【自分のGitHubのアカウントをリンク】
- 自分は、英語版と日本語版を併記しています。
関連情報
参考
- mignonstyle/markdown-cheatsheet.md | GitHub Gist
- Markdown記法 チートシートが一通りまとめて記載されている
- githubのmarkdownをプレビューする一つの方法 | Qiita
- README.mdのプレビュー方法が記載されている
以上！
コメント