GFM test
2022/2/20+
This is head1
=============
This is head 2
————–
First Header | Second Header |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
Item | Value |
---|---|
Computer | $1600 |
Phone | $12 |
Pipe | $1 |
http://google.com
this is good bad
this is the 2^(nd) time
This is underlined but this is still italic
This is ==highlighted==
some blue text
#ffce44
rgb(255,0,0)
rgba(0,255,0,0.4)
hsl(100, 10%, 10%)
hsla(100, 24%, 40%, 0.5)
1個から6個シャープで見出しを記述する。
※シャープと見出し文字の間には半角スペースを1つ入れること
ハイフン、プラス、アスタリスクのいずれかで箇条書きリストを記述可能。
※ハイフン、プラス、アスタリスクと箇条書きの項目の間には半角スペースを1つ入れること
数値+半角ドットで番号付きリストを記述可能。
番号の内容は何でもいい。実際に表示される際に適切な番号で表示される。
そのため、一般的にはすべて 1. 内容 で記載すると変更に強く楽です。
※数値+半角ドットと箇条書きの項目の間には半角スペースを1つ入れること
お世話になります。xxxです。
ご連絡いただいた、バグの件ですが、仕様です。
お世話になります。 yyyです。
あの新機能バグってるっすね
半角スペース4個もしくはタブで、コードブロックをpre表示できます
# Tab
class Hoge
def hoge
print 'hoge'
end
end
# Space
class Hoge
def hoge
print 'hoge'
end
end
バッククォートで文字列を囲むことでコードの一部を表示可能です。
インストールコマンドは gem install hoge
です
normal italic normal
normal italic normal
normal bold normal
normal bold normal
normal bold normal
normal bold normal
アンダースコア、アスタリスク、ハイフンなどを3つ以上連続して記述することで水平線を表示します。
※連続するハイフンなどの間にはスペースがあっても良い
X ___ Y(下にスペースが必要)
Z(下にスペースが必要)
[表示文字](リンクURL)形式でリンクを記述できます
Markdownの文書の途中に長いリンクを記述したくない場合は、
同じリンクの参照を何度も利用する場合は、リンク先への参照を定義することができます。
こっちからgoogle
その他の文章
こっちからもgoogle
https://www.google.co.jp/
チルダ2個で文字列を囲むことで取り消し線を利用できます。
取り消し線
class Hoge
def hoge
print 'hoge'
end
end
class Hoge
def hoge
print 'hoge'
end
end
チルダ、もしくはバッククォート3つの後ろに対象シンタックスの言語名を記述します。
class Hoge
def hoge
print 'hoge'
end
end
header1 | header2 | header3 |
---|---|---|
align left | align right | align center |
a | b | c |
GitHubのMarkdownを利用すると、見出し記法を利用した際に
アンカーが自動的に作成されます。
そのアンカーを利用したページ内リンクを簡単に作成できます。
==== Emojis ====
バグ修正
機能改善
部分的な機能追加
盛大に祝うべき大きな機能追加
リファクタリング
不要な機能・使われなくなった機能の削除
テストやCIの修正・改善
Lintエラーの修正やコードスタイルの修正
パフォーマンス改善
依存パッケージなどのアップデート
新機能の公開範囲の制限
セキュリティ関連の改善
ドキュメント
デザインUI/UX
パフォーマンス
ツール
テスト
非推奨追加
削除
WIP
ファイルの移動
バージョンタグ
Use Mermaid syntax to create diagrams
flowchart
graph TD
A(Coffee machine <br>not working) --> B{Machine has power?}
B -->|No| H(Plug in and turn on)
B -->|Yes| C{Out of beans or water?} -->|Yes| G(Refill beans and water)
C -->|No| D{Filter warning?} -->|Yes| I(Replace or clean filter)
D -->|No| F(Send for repair)
Gantt chart
gantt
title Example Gantt diagram
dateFormat YYYY-MM-DD
section Team 1
Research & requirements :done, a1, 2020-03-08, 2020-04-10
Review & documentation : after a1, 20d
section Team 2
Implementation :crit, active, 2020-03-25 , 20d
Testing :crit, 20d
UML class diagram
classDiagram
Person <|-- Student
Person <|-- Professor
Person : +String name
Person : +String phoneNumber
Person : +String emailAddress
Person: +purchaseParkingPass()
Address "1" <-- "0..1" Person:lives at
class Student{
+int studentNumber
+int averageMark
+isEligibleToEnrol()
+getSeminarsTaken()
}
class Professor{
+int salary
}
class Address{
+String street
+String city
+String state
+int postalCode
+String country
-validate()
+outputAsLabel()
}
UML sequence diagram
sequenceDiagram
autonumber
Student->>Admin: Can I enrol this semester?
loop enrolmentCheck
Admin->>Admin: Check previous results
end
Note right of Admin: Exam results may <br> be delayed
Admin-->>Student: Enrolment success
Admin->>Professor: Assign student to tutor
Professor-->>Admin: Student is assigned
Pie chart
pie title Commits to mxgraph2 on GitHub
"Sunday" : 4
"Monday" : 5
"Tuesday" : 7
"Wednesday" : 3
simple0
graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
simple1
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
以上