Markdown記法と書き方
# 目次
- [Markdown（マークダウン）とは](#markdownマークダウンとは)
- [見出し](#見出し)
- [テキストの装飾（強調・斜体・打ち消し線・下線・文字色・サイズ）](#テキストの装飾)
- [リスト](#リスト)
- [画像](#画像)
- [リンク](#リンク)
- [コード（コードブロック・インラインコード）](#コード)
- [チェックボックス](#チェックボックス)
- [引用](#引用)
- [折りたたみ](#折りたたみ)
- [数式](#数式)
- [テーブル](#テーブル)
- [差し込みメモ](#差し込みメモ)
- [UMLやフローチャートシーケンス図](#umlやフローチャートシーケンス図)
- [Mermaid (マーメイド) 記法](#mermaid-マーメイド-記法)
- [PlantUML記法](#plantuml記法)
- [注釈](#注釈)
## Markdown（マークダウン）とは
Markdown（マークダウン）は、簡単な記号を使って文章の構造や装飾を指定できるマークアップ言語です。例えば、`#`で見出し、`*`で強調、`-`で箇条書きなどを表現できます。HTMLに変換可能で、文書作成やブログ投稿によく使われています。
### DocBaseでのMarkdownの書き方
DocBaseではMarkdownの標準化された仕様である**CommonMark**を採用していますので安心して利用いただけます。
またDocBaseのMarkdownエディタは、画面左側で直接Markdownを編集しながら、右側でリッチテキストとして直接編集できる[ハイブリッドモード](https://help.docbase.io/posts/3277664)を搭載しています。
「Markdownの記法を覚えたいけど、最初は難しそう...」という方にもおすすめです。
# 見出し
`# `（シャープと半角スペース）の後に文字を書くと、その行は見出しとして表示されます。
`#`の数によって見出しのレベルを表すことができます。
また、レベル1とレベル2の見出しは代替の記法があります。
```
# 見出しレベル1
## 見出しレベル2
### 見出しレベル3
#### 見出しレベル4
##### 見出しレベル5
見出しレベル1
=========
見出しレベル2
---------
```
**実際の表示**
# 見出しレベル1
## 見出しレベル2
### 見出しレベル3
#### 見出しレベル4
##### 見出しレベル5
見出しレベル1
=====
見出しレベル2
---------
## ハイブリッドモード（リッチテキスト）での操作方法
[ハイブリッドモード](https://help.docbase.io/posts/3277664)または[リッチテキストモード](https://help.docbase.io/posts/3027206)から簡単に入力できます。
詳しくはこちらをご確認ください。
#{3277692}
# テキストの装飾
## 強調
強調したいテキストは`**`（アスタリスク2つ）で囲みます。
```
お寿司は**とても**おいしいです。
```
**実際の表示**
お寿司は**とても**おいしいです。
## 斜体
斜体で表示したいテキストは`*`（アスタリスク1つ）で囲みます。
```
好きな寿司ネタは*炙りサーモン*です。
```
**実際の表示**
好きな寿司ネタは*炙りサーモン*です。
## 打ち消し線
打ち消し線を引きたいテキストは`~~`（チルダ2つ）で囲みます。
```
お寿司は~~おいしくない~~おいしいです。
```
**実際の表示**
お寿司は~~おいしくない~~おいしいです。
## 下線
下線を引きたいテキストは``で囲みます。
```
お寿司はおいしいです。
```
**実際の表示**
お寿司はおいしいです。
## ハイライト
ハイライトしたいテキストは``で囲みます。
```
好きな寿司ネタは炙りサーモンです。
```
**実際の表示**
好きな寿司ネタは炙りサーモンです。
## 文字色とサイズ
Markdown記法では文字色やサイズ変更は対応していません。
HTMLタグを記入するか、[リッチテキストモード](https://help.docbase.io/posts/3027206)または[ハイブリッドモード](https://help.docbase.io/posts/3277664)からテキストを選択することで変更できます。
```
好きな寿司ネタは炙りサーモンです。
好きな寿司ネタは炙りエンガワです。
```
**実際の表示**
好きな寿司ネタは炙りサーモンです。
好きな寿司ネタは炙りエンガワです。
## ハイブリッドモード（リッチテキスト）での操作方法
[ハイブリッドモード](https://help.docbase.io/posts/3277664)または[リッチテキストモード](https://help.docbase.io/posts/3027206)から簡単にテキストを装飾することができます。
1. 装飾したいテキストを選択
1. メニューから任意のボタンを選択
詳しくはこちらをご確認ください。
#{3277703}
# リスト
## 番号なしのリスト
順序が関係ないリストは、行の先頭に`* `（アスタリスクと半角スペース）もしくは`- `（ハイフンと半角スペース）を入れ、テキストを書きます。
リストを入れ子にすることもできます。
```
* タイ
* ヒラメ
* 軍艦
* ウニ
* イクラ
- マグロ
- カツオ
- 炙りもの
- 炙りサーモン
- 炙りエンガワ
```
**実際の表示**
* タイ
* ヒラメ
* 軍艦
* ウニ
* イクラ
---
- マグロ
- カツオ
- 炙りもの
- 炙りサーモン
- 炙りエンガワ
## 番号ありのリスト
`1. `など、数字の後にドットと半角スペースを入れテキストを書きます。
```
1. マグロ
1. カツオ
1. タイ
1. ヒラメ
```
**実際の表示**
1. マグロ
1. カツオ
1. タイ
1. ヒラメ
## ハイブリッドモード（リッチテキスト）での操作方法
[ハイブリッドモード](https://help.docbase.io/posts/3277664)または[リッチテキストモード](https://help.docbase.io/posts/3027206)からリストアイテムをドラッグ＆ドロップで並び替えできます。
# 画像
画像は以下の記法で表すことができます。
`[]`内は画像のタイトル、`()`内は画像のURLです。
タイトルは空欄でも表示できます。
```
```
**実際の表示**
## 画像のサイズ指定
次のように画像のURLの後ろに半角スペースをあけ、`=幅ピクセルx縦ピクセル`で画像サイズを指定できます。`x`は半角アルファベットのエックスです。
**※ 画像のサイズ指定はMarkdownの標準機能ではなく、DocBase独自の拡張機能です。**
```
```
また、幅サイズと縦サイズの指定はそれぞれ省略可能です。
```
 // 縦を省略
 // 幅を省略
```
### 縦横200pxで指定した場合
```
```
**実際の表示**
### 幅200pxで指定した場合
```
```
**実際の表示**
### 縦200pxで指定した場合
```
```
**実際の表示**
### フルサイズでの表示
縦長の画像の場合、自動的にサイズを小さくして表示しますが、`=full`と指定することでフルサイズで表示するように指定できます。
```
```
**実際の表示**
## ハイブリッドモード（リッチテキスト）での操作方法
[ハイブリッドモード](https://help.docbase.io/posts/3277664)または[リッチテキストモード](https://help.docbase.io/posts/3027206)から簡単に画像サイズを変更できます。
詳しくはこちらをご確認ください。
#{3277706}
# リンク
リンクは以下の記法で表すことができます。
`[]`の中はリンクさせたいテキスト、`()`の中はURLです。
画像の記法とよく似ていますが、リンクには画像にある先頭の`!`がありません。
```
[寿司 - Wikipedia](http://ja.wikipedia.org/wiki/%E5%AF%BF%E5%8F%B8)
```
**実際の表示**
[寿司 - Wikipedia](http://ja.wikipedia.org/wiki/%E5%AF%BF%E5%8F%B8)
## DocBase内の他のメモへのリンク
`[Markdownの書き方](https://help.docbase.io/posts/13697/)`のように、通常のリンクとして書くこともできます。投稿画面で、行の先頭か空白の後に`#[`と入力すると、最近更新されたメモのリストが表示されます。リストからメモを選ぶとリンクが入ります。候補は最大100件です。
# コード
## コードブロック
コードブロックを書くには\`\`\`（バッククオート3つ）で段落を囲みます。
\`\`\`の後に言語の名前を書くと、その言語に合わせてコードがハイライトされます。
また、コードブロックにはファイル名を指定することができます。
はじめの\`\`\`の後、または言語指定の後に`:`を先頭に付けて書いた文字がファイル名として表示されます。
\`\`\`ruby:sushi.rb
def sushi
puts 'お寿司'
end
\`\`\`
**実際の表示**
```ruby:sushi.rb
def sushi
puts 'お寿司'
end
```
## インラインコード
文章の中にインラインのコードを書くこともできます。
その場合は\`（バッククオート1つ）でテキストを囲みます。
```
寿司をローマ字で書くと`sushi`です
```
**実際の表示**
寿司をローマ字で書くと`sushi`です
# チェックボックス
チェックボックスは`- [ ]`の後にテキストを書くことで表せます。
未チェックの場合は`[]`の中に半角スペース、チェック済みの場合は`[]`の中に`x`（エックス）を入れます。
**※リストの中、かつ`[ ]`の後にテキストがなければ表示されません。**
```
- [ ] マグロ
- [ ] コハダ
- [x] エンガワ
```
**実際の表示**
- [ ] マグロ
- [ ] コハダ
- [x] エンガワ
※チェックボックスに続けて半角の`(`を書く場合、Markdownがうまくパースできず正常に表示できなくなってしまうので、以下のように`(`の前に`\`をつけてください。
```
- [ ] \(abc)
```
# 引用
引用は`> `（不等号と半角スペース）の後にテキストを書きます。
1行目に`>`を書いておけばその後に続く行も引用とみなされます。
```
> お寿司が好きです。
毎日食べたいです。
```
**実際の表示**
> お寿司が好きです。
毎日食べたいです。
# 折りたたみ
``タグでコンテンツを折りたたむことができます。
※ ``を書いた行の次に空行を入れてから、折りたたむ内容を書いてください。下の例では、空行がないと`- 寿司`などがリストにならず、そのまま表示されます。
```
詳細を見る
- 寿司
- エンガワ
- 炙りサーモン
詳細を見る
- 寿司
- エンガワ
- 炙りサーモン
`タグで囲むことができます。
# 数式
数式はコードブロックの言語指定を`math`にすると表示できます。
使用できる記法はTeX記法（MathJax）になります。
### ブロック数式
次の例では、`\begin{equation}`と` \end{equation}`で囲むとブロックの数式として表示されます。
詳しくは[LaTeXの数式の書き方（外部ページ）](https://en.wikibooks.org/wiki/LaTeX/Mathematics)を参照してください。
```math
\begin{equation}
sushi=
\begin{pmatrix}
** & \cdots & \cdots & \cdots & \cdots & ** \\
\cdots & L & O & V & E & \cdots &\\
\cdots & A & N & D & \cdots & \cdots \\
\cdots & P & E & A & C & E \\
** & \cdots & \cdots & \cdots & \cdots & ** \\
\end{pmatrix}
\end{equation}
```
```math
\begin{equation}
sushi=
\begin{pmatrix}
** & \cdots & \cdots & \cdots & \cdots & ** \\
\cdots & L & O & V & E & \cdots &\\
\cdots & A & N & D & \cdots & \cdots \\
\cdots & P & E & A & C & E \\
** & \cdots & \cdots & \cdots & \cdots & ** \\
\end{pmatrix}
\end{equation}
```
### インライン数式
`$`と`$`で囲むとインライン数式として表示できます。
```
$ e^{i\theta} = \cos\theta + i\sin\theta $
```
**実際の表示**
$ e^{i\theta} = \cos\theta + i\sin\theta $
※ 数式として表示したくない行では、特定の`$`の周りにspanタグを使用してください。
```
$これは数式ではありません$
```
### 1行数式
`$$`と`$$`で囲むと1行の数式として表示できます。
```
$$ e^{i\theta} = \cos\theta + i\sin\theta $$
```
**実際の表示**
$$ e^{i\theta} = \cos\theta + i\sin\theta $$
### 数式が正常に表示されない場合
次のような数式の場合、`_` がMarkdownの斜体と認識されるため、正常に表示されません。
`$E'_R $, $E'_G$, $E'_B$`
エスケープすることで正常に表示されるようになります。
`$E'\_R $, $E'\_G$, $E'\_B$`
$E'\_R $, $E'\_G$, $E'\_B$
# テーブル
以下のように書くとテーブルを表すことができます。
2行目の`-`（ハイフン）は、セルひとつにつき最低3つ書く必要があります。
また、セルのアライン指定（右寄せ、左寄せ、中央寄せ）にも対応しています。
アライン指定したい列の`|---|`に`:`を追加します。
左寄せであれば`|:---|`、中央寄せであれば`|:---:|`、右寄せであれば`|---:|`と入力します。
```
|赤身|白身|軍艦|
|:---|:---:|---:|
|マグロ|ヒラメ|ウニ|
|カツオ|タイ|イクラ|
|トロ|カンパチ|ネギトロ|
```
**実際の表示**
|赤身|白身|軍艦|
|:---|:---:|---:|
|マグロ|ヒラメ|ウニ|
|カツオ|タイ|イクラ|
|トロ|カンパチ|ネギトロ|
詳しくは[Markdown 表テーブルの書き方](https://help.docbase.io/posts/3718072)をご確認ください。
#{3718072}
## ハイブリッドモード（リッチテキスト）での操作方法
[ハイブリッドモード](https://help.docbase.io/posts/3277664)または[リッチテキストモード](https://help.docbase.io/posts/3027206)から簡単にテーブルを操作できます。
詳しくは[こちら](https://help.docbase.io/posts/3224067)をご確認ください。
#{3224067}
# 差し込みメモ
DocBaseの独自機能として、メモに他のメモを差し込むことができます。
`#{}`の波括弧の中にメモのid、またはURLを入れると、差し込みメモとして表示できます。
（URLが`https://help.docbase.io/posts/13674`であれば、`13674`の部分になります）
投稿画面で行の先頭に`#{`と入力すると、最近更新されたメモのリストが表示されます。リストからメモを選ぶと差し込めます。
```
#{13674}
#{https://help.docbase.io/posts/13674}
```
**実際の表示**
#{13674}
#{https://help.docbase.io/posts/13674}
# UMLやフローチャート、シーケンス図
## Mermaid (マーメイド) 記法
Mermaid（マーメイド）とは、Markdownに似たシンプルなテキスト記法を利用して、動的な図やチャートを生成できるJavaScriptベースのツールです。
Mermaidで図を記述する際は、コードブロック内に「mermaid」言語識別子を指定し、その中に図の定義を記述します。以下は、シンプルなフローチャートの例です:
```mermaid
graph TD;
A[開始] --> B[処理];
B --> C{判断};
C -- はい --> D[処理1];
C -- いいえ --> E[処理2];
D --> F[終了];
E --> F;
```
~~~
```mermaid
graph TD;
A[開始] --> B[処理];
B --> C{判断};
C -- はい --> D[処理1];
C -- いいえ --> E[処理2];
D --> F[終了];
E --> F;
```
~~~
詳しくは[Mermaid (マーメイド) 記法と書き方](https://help.docbase.io/posts/3719897)をご確認ください。
#{3719897}
## PlantUML記法
PlantUMLは、テキスト記述からUML（Unified Modeling Language）図を自動生成するオープンソースのツールです。ソフトウェア設計や要件定義の視覚化に広く使用されています。
クラス間の関係や構造を表現する図です。
```uml
@startuml
class Car {
- String model
- int year
+ void start()
+ void stop()
}
class Driver {
- String name
+ void drive(car)
}
Driver --> Car : drives
@enduml
```
~~~
```uml
@startuml
class Car {
- String model
- int year
+ void start()
+ void stop()
}
class Driver {
- String name
+ void drive(car)
}
Driver --> Car : drives
@enduml
```
~~~
詳しくは[PlantUML記法と書き方](https://help.docbase.io/posts/3720083)をご確認ください。
#{3720083}
# 注釈
```
今夜は寿司[^1]です。
[^1]: 酢飯の上になんか色々載せた食べ物
```
**実際の表示**
今夜は寿司[^1]です。
[^1]: 酢飯の上になんか色々載せた食べ物
---
### マニュアル作成、ナレッジ共有なら「DocBase」
[](https://docbase.io/)
「情報や知識の共有がうまくいかない、特定の人に偏ってしまう」
「知識の再利用がうまくできれば、強い組織にできるのではないか？」
DocBaseはこのような弊社の課題から生まれたサービスです。
情報やナレッジの共有だけでなく、マニュアル整備が進まないのも、次のような「共有するための情報を作る難しさ」があります。
- 正しく立派なドキュメントを作らなくてはいけない
- 情報が多すぎてまとめる時間がない
DocBaseでは「正しく立派なドキュメントを作る」ではなく、「**小さく始めて、情報を育てて、チームを育てる**」をコンセプトにメモという小さな単位での情報共有、複数のメモを体系的にまとめて情報を育てる、複数人で同時にメモを作るということができるようになっています。
### DocBaseの特長
- **3つの編集モード**で誰でも使える、爆速で共有できる新エディター
- マニュアル作成に便利な**画像に矢印やテキストを簡単に配置**できるペイントモード
- **OfficeファイルやPDFの中身も全文検索**できる強力な検索機能
- **ワンクリックで他のドキュメントを参照**できるから情報の再利用が簡単
- みんなでメモを作り上げる強力な**同時編集機能**
- シングルサインオンや2段階認証、操作履歴、ISMS取得など**安心のセキュリティ**
- **ChatGPTやClaudeなど様々なAIアプリとの連携機能**でナレッジ共有を簡単自動化
👉 [AIアプリとの連携機能](https://help.docbase.io/posts/3919854)
👉 [その他、豊富な機能](https://docbase.io/features)
[](https://docbase.io/teams/new) [](https://docbase.io/document_requests/new)