メインコンテンツまでスキップ

Markdown記法の概要

Markdown 記法のうち、主要な記法を解説します。

なお、IT 管理部ではマークダウンエディタを独自に実装しているので、是非使ってみてください。

なお、Markdown 記法にはいわば「方言」と表現できる、一部のサイトでのみ使用できる記法(拡張記法)が存在することに注意してください。 以下に主要サイトの記法を解説したページを掲載しています。Markdown を書く際にはそれぞれのサイトで使用できる記法を確認しておくことをお勧めします。

  • Zenn (IT 管理部独自のマークダウンエディタで使用できる記法)
  • GitHub
  • Discord

見出し

1-6 個の#(シャープ)で記述します。数の多いほど小さな見出しとなります。 #と見出しに使用する文字の間は半角スペースを挿入します。

# 見出し 1

## 見出し 2

### 見出し 3

#### 見出し 4

##### 見出し 5

###### 見出し 6

注記

表記例はこの部分のみ画像になっています。


リスト

*ないし-を行頭につけます。見出し同様、文字列との間に半角スペースが必要です。

- 乃木坂 46
- 櫻坂 46
- 日向坂 46
- はなちゃんず
* カラーチャート
  • 乃木坂 46
  • 櫻坂 46
  • 日向坂 46
    • はなちゃんず
    • カラーチャート

リストは入れ子にすることができ、この場合行頭(記号の前)にタブスペースを挿入します。

番号付きリスト

行頭に数値.(半角ドット)をつけます。数値はなんでも良く、表示する際に自動で付番されます。

1. IT 管理部
2. ステージ班
1. 有志担当
2. クラス企画担当
3. 模擬店班
1. 食飯
1. 部活動
1. そのほか
  1. IT 管理部
  2. ステージ班
    1. 有志担当
    2. クラス企画担当
  3. 模擬店班
    1. 食飯
    2. 部活動
    3. そのほか

リンク

[アンカーテキスト](URL)で記述します。 なお、URL のみで記述することもできます。

[茨城県立古河中等教育学校](https://www.koga-cs.ibk.ed.jp)

https://www.koga-cs.ibk.ed.jp

茨城県立古河中等教育学校

https://www.koga-cs.ibk.ed.jp

画像

![代替テキスト](画像のURL or パス)で記述します。

ローカルで使用する際は markdown ファイルからの相対パスか絶対パスで画像のパスを記述することで画像を挿入することができます。

代替テキストは画像が表示できない場合に表示されるほか、音声読み上げの際に使用される文言です。視覚障がいがある方などがスクリーンリーダを使用し情報を受け取ることができるようになり、Web アクセシビリティを向上させることができます。

![公認キャラクター シグマン](https://www.koga-cs.ibk.ed.jp/wysiwyg/image/download/1/5255/medium)

公認キャラクター シグマン

引用

行頭に>をつけ、文章との間に半角スペースを挿入します。

> ある日の暮方の事である。一人の下人が、羅生門の下で雨やみを待っていた。
>
> 「羅生門」(芥川龍之介より)

ある日の暮方の事である。一人の下人が、羅生門の下で雨やみを待っていた。

「羅生門」(芥川龍之介より)

コードブロック

コード部分を ``` で囲むことでコードブロックとなります。サイトやエディタによっては言語を指定することでシンタックスハイライトが適用されることがあります。

```js
const hello = () => {
console.log("Hello World!");
};
```
const hello = () => {
console.log("Hello World!");
};

IT 管理部のマークダウンエディタではシンタックスハイライトが適用されます。対応言語と略称は以下の通りです。

対応言語一覧と略称

区切り線

章の区切り等には区切り線があるとみやすくなります。

---

インラインスタイル一覧

文章中の文字を装飾したい場合にはインラインスタイルの記法を使用します。

斜体

斜体(イタリック)は*(アスタリスク)もしくは_(アンダーバー)1 個で文字列を囲むことで表現できます。

この記事は _2022 年 12 月 15 日_ に執筆されました。

この記事は 2022 年 12 月 15 日 に執筆されました。

強調

強調は(ボールド)は*(アスタリスク)2 個で文字列を囲むことで表現できます。

IT 管理部の **eno1220** です。よろしくお願いします。

IT 管理部の eno1220 です。よろしくお願いします。

インラインコード

インラインコードは ` で文字列を囲むことで表現できます。

おもに `next.js``tailwindCSS`を使用して web 制作を行なっています。

おもに next.jstailwindCSSを使用して web 制作を行なっています。

さいごに

Markdown 記法はエンジニアが多く使用するサービスで使えることが多い印象があります。 このほか、Markdown を使用して本を作成することなんかもできたりします。 ぜひ Markdown 記法を覚えてよりよいエンジニアライフを送りましょう!