はじめに
自分は10月よりAPPRENTICE SHIP(内定直結型エンジニア学習プログラム)のカリキュラムに２期生として参加しています。
その一環としてチーム開発を行っており、技術情報をまとめることで学習に役立てるよう、記事を作成しております。
MarkDownとは？
Markdown（マークダウン）は、文書を記述するための軽量マークアップ言語のひとつである。本来はプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発されたものである。しかし、現在ではHTMLのほかパワーポイント形式やLATEX形式のファイルへ変換するソフトウェア（コンバータ）も開発されている。各コンバータの開発者によって多様な拡張が施されるため、各種の方言が存在する。
Markdown - Wikipedia より
Markdownチートシート
実際に使い始めてみて
MarkDown記法を生活の中で使うようになって、３ヶ月(2024/1 現在)になりました。
VScodeでドキュメントなどを書くようになり、有り難みをひしひしと感じています。
「Notion」「Discode」などのアプリケーションでも対応しており、文章を書くのに欠かせない存在となってきました。
ここで改めて、マークダウンの書き方をおさらいしていきたいと思います。
よく使う！基本的な記法
Markdownにおける改行と段落の作成方法について説明します。
改行
Markdownでは、行の終わりにスペースを2つ入れることで改行が出来ます。
これは最初の行です。
これは新しい行です。
この例では、です。 の後にスペースを2つ入れています。これにより「これは新しい行です。」が新しい行に表示されます。
段落
新しい段落を作成するには、空白行を一行挿入します。つまり、段落間には何も書かない行を1行入れるだけです。
これは最初の段落です。
これは二番目の段落です。
この例では、2つのテキストブロックの間に空白行があります。これにより、それぞれが独立した段落として表示されます。
見出し
見出しは#（シャープ）を使用して表現されます。見出しのレベルに応じて#の数を増減させます。
# これはH1見出しです
## これはH2見出しです
### これはH3見出しです
リスト
リストは順序付きリスト（番号つきリスト）と順序なしリスト（マークつきリスト）の2つがあります。
順序付きリストの例：
- 項目1
- 項目2
- 項目3
順序なしリストの例：
- アイテム1
- アイテム2
- アイテム3
また、順序なしリストは*や+、-を使って表現することもできます。
リンク
リンクを挿入するには、リンクテキストの形式を使用します。
[Google](https://www.google.com)
これにより、"Google"というテキストがリンクとして表示されます。
画像
画像を挿入するには、の形式を使用します。
これにより、代替テキストが表示される場所に画像が表示されます。
引用
Markdownでは、文章を引用する際には「>」 を使用します。これにより、テキストが引用としてフォーマットされます。
これは引用の例です。
コード挿入
コードブロックを挿入するには、バックティック（`）を使用します。単一行のコードには単一のバックティックを、複数行のコードには3つのバックティックを使用します。言語を指定することもできます。
Copy code
console.log('Hello, world!');
ruby
Copy code
puts 'The best way to log and share programmers knowledge.'
水平線
文章内でセクションを分けるための水平線を挿入するには、3つのハイフン（---）を使用します。
これはセクションの前のテキストです。
これはセクションの後のテキストです。
強調
テキストを強調するためには、アスタリスク（*）またはアンダースコア（_）を使用します。イタリック体にするには1つ、太字にするには2つ使用します。
markdown
Copy code
*イタリック体*
**太字**
markdown
Copy code
イタリック体
太字
所感
改めて、マークダウン記法を振り返りましたが、まだまだ使っていない記法があります。
Qiitaでは、これ以外にも独自の記法があったりと、奥が深いですね。。。
これからも、マークダウンを使って綺麗なドキュメントが書けるようにしていきたいものです。