Markdown記法

更新日 2022/03/31
作成日 2022/03/01

Redmineでは、チケットの説明、注記、wikiなどでMarkdown記法と、Textile記法が使えます。表、リストなどの表現が簡潔な記法で行えます。また、Redmine 5.0では、CommonMark が試験的にサポートされ、HTMLタグやタスクリストが利用できるようになりました。

ここでは、Markdown記法を紹介します。

記法はテキスト入力エリア上部のツールバーの右端にあるヘルプボタンからも参照できます。

文字に対する書式

Markdown 説明・表示例
**太字**
*斜体*
***太字で斜体***
~~取消線~~
`コード` ` で囲まれた部分を等幅フォントで表示します。行内にソースコードを記述するときなどに使用します。
複数行にわたるソースコードの場合は ``` で囲みます(記法例)。

引用

Markdown 説明・表示例
> 文頭に> (>の後は半角スペース)を入力すると引用となります。

記法例
> ゴーシュは控室のごつごつマッチたちを曲をすん間ましな。そしてまた生意気ございならって硝子たです。
> いいかげんないたんたはたけれども室の大丈夫団の所にもどうもいい気だですで、ここらだけ眼をもっられんたた。運びすぎきみは舌をいいたてさっきの先生の療目へひる第二人たちの話で出しとしまっですない。まわりは今弾きて来まし。向うは十くっつけ頭のようへおくれてしまいまし。
> むりはゴーシュゴーシュと何をきかせが出します。
> かっこうもお父さんをとてもに聞いてへんからょってじぶんののようにつりあげて遁に教えるがしきりに楽譜と弾くてあげだ。
> じっともう慈悲を歌がなんたませ。

表示例

リスト(順不同リスト・番号つきリスト・タスクリスト)

Markdown 説明・表示例
* the
* quick
  * brown
     * fox
     * jumps
  * over
  * the
* lazy
* dog
順不同リスト

1. the
2. quick
  1. brown
     1. fox
     2. jumps
  2. over
  3. the
3. lazy
4. quick
番号つきリスト

* [ ] the
* [x] quick
* [x] brown
対応バージョン:Redmine 5.0以降
テキスト書式(「管理」→「設定」→「全般」→「テキスト書式」)が CommonMark Markdown の場合に利用できます。

[ ]の中にxを入力するとチェックが入ります。

見出し

HTMLにおける<h1>~<h6>を表示できます。

Markdown 説明・表示例
# 見出し1

## 見出し2

### 見出し3

#### 見出し4

##### 見出し5

###### 見出し6

水平線

Markdown 説明・表示例
--- 水平線(横線)を表示します。HTMLの<hr>に相当します。

リンク

Markdown 説明・表示例
https://redmine.jp 直接URLを入力すると、自動的にクリック可能なリンクに変換して表示します。

[Redmine.JP](https://redmine.jp/) URLの代わりに特定のテキストを表示したい場合、[特定のテキスト](URL)で記述します。

テーブル(表)

Markdown 説明・表示例
|コード|県名|県の鳥|
|--|--|--|
|31|鳥取県|オシドリ|
|32|島根県|ハクチョウ|
|--|の上に記述したテキストは、テーブルヘッダ(HTML: <th>)として表示します。

|コード|県名|県の鳥|
|--:|:--|:--:|
|31|鳥取県|オシドリ|
|32|島根県|ハクチョウ|
列ごとにテキストの左寄せ・右寄せ・中央寄せを指定できます。
|--:| 右寄せ
|:--| 左寄せ
|:--:| 中央寄せ

テキスト入力エリア上部のツールバーにあるテーブル挿入ボタンからもテーブルを作成できます。
Wikiツールバーのテーブル挿入ボタン - Redmineの意外と知らない便利な機能(Redmine.JP Blog)

整形済みテキスト

ソースコードなど、整形やMarkdownによる加工を行わせずそのまま表示したいテキストは ``` で囲みます。

記法例

```
using System;

internal static class HelloWorld
{
    private static void Main()
    {
        Console.WriteLine("Hello, world!");
    }
}
```

表示例

整形済みテキスト + シンタックスハイライト

言語のソースコードはシンタックスハイライトを行って見やすく表示することもできます。この機能はMarkdownの機能ではなくRedmineでのみ利用可能な独自の拡張です。

コードブロックを指定する ``` のすぐ後でシンタックスハイライト対象の言語名指定します。
対応言語の詳細は以下のページでご確認ください。

記法例(C#の場合)

``` csharp
using System;

internal static class HelloWorld
{
    private static void Main()
    {
        Console.WriteLine("Hello, world!");
    }
}
```

表示例

関連情報

Redmineのクラウドサービス「My Redmine」です。
オンプレミスからの移行もOK!無料の1ヶ月お試し受付中です!

無料で試してみる