Githubフレーバーマークダウン
こんにちは、トムです(英語版またはドイツ語版で読み上げを使用している場合は、お気に入りのWaveNet音声)。最近、Github Markdownを使用するための、まだ知らないかもしれない便利で便利なトリックをいくつか見てきました。見てみましょう!
キーボードショートカット
Github Markdownでは、キーボードショートカットを説明するための標準のHTMLタグとして認識できるタグ「」を使用することもできます。ショートカットを説明するプレーンテキストを2つの「」要素の間に置くだけで、Githubが正しくレンダリングします。
### Keyboard shortcut
<kbd>Cmd + C</kbd>
<kbd>ESC</kbd>
詳細と概要
既知のHTMLタグについてもう少し詳しく説明し、詳細と概要要素を見てみましょう。 HTMLの場合と同様に、詳細要素は折りたたみ可能であり、ユーザーが詳細ビューを開くまで情報(詳細の概要)を非表示にします。まったく同じことがGithubのMarkdownでも利用できます。
### Summary and details
<details>
<summary>A summary title</summary>
And that's a summary content.
</details>
色
新しいプルリクエストを作成するときに、16進数の色の定義をバッククォートに入れることができ、GithubはそれをMarkdownで特別な色タグとしてレンダリングします。この要素には、テキストバリアントの色が含まれているだけでなく、定義された色を表すドットが表示され、どのように見えるかをすばやく確認できます。
### Colors
For your PR's pleasure:
`#3285A8`
取り消し線
取り消し線を引くテキスト選択の最初と最後にそれぞれ2つのチルダ記号を使用すると、取り消し線が適用されます。チルダ記号は、間に空白を入れずに最初と最後の文字に直接追加する必要があることに注意してください。
### Strikethrough
This a sentence. ~~This was a sentence.~~
特定のコード定義
Markdownコードの最初と最後にある3つのバッククォートを使用して、コードブロックを定義できます。プログラミング言語を最初の3つのバッククォートに直接追加することで、Github Markdownは正しい構文の強調表示を推測し、コードレビューの読みやすさを向上させることができます。
### Specified code language
```typescript
function add(a: number, b: number){
return a + b;
}
### メディア
Githubは、Markdownでの画像とビデオのインライン表示もサポートしています。知っておきたいこと:マークダウンエディターの関連ボタンをクリックするか、ドラッグアンドドロップを使用してメディアを追加できます。
## 簡単な記事の終わり
この記事を読んでいる場合は、GithubMarkdownで利用可能な要素のほとんどに精通している可能性があります。上に挙げたいくつかの要素は、私が今まで聞いたことがない要素なので、それらをあなたと共有することは理にかなっていると思いました。たぶん、あなたは今も初めてそれらを見て、今日何か新しいことを学びました。
トム