0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Markdownの概要と利用方法

Last updated at Posted at 2025-01-02

Markdownは、テキストをHTMLに変換するための軽量マークアップ言語です。John Gruberによって2004年に開発され、主にブログやオンラインフォーラム、ドキュメント作成に利用されています。Markdownは、読みやすく、書きやすいプレーンテキスト形式を使用し、構造的に有効なXHTMLまたはHTMLに変換できます。

Markdownの特徴

1. 読みやすさ

Markdownの設計目的は、書いたテキストがそのまま読みやすく表示されることです。HTMLタグでマークアップされていることがわからないように、簡単な記法で表現できます。

2. シンプルな構文

Markdownの構文は、以下のようにシンプルで直感的です。

  • 見出し: # 見出し1, ## 見出し2
  • 強調: *イタリック***ボールド**
  • リスト: - リスト項目 または 1. 番号付きリスト

3. 拡張性

Markdownは、さまざまなプラットフォームやアプリケーションで利用でき、機能を拡張するためのプラグインやカスタムスタイルも存在します。GitHubでは、Markdownにテーブルやタスクリストなどの機能が追加されています。

Markdownの基本的な使用法

書き方

Markdownを書くには、通常のテキストエディタでテキストを入力し、特定の記号を使用してフォーマットを指定します。以下にいくつかの基本例を示します。

見出し

# 見出し1
## 見出し2
### 見出し3

強調

*イタリック*
**ボールド**

リスト

- アイテム1
- アイテム2
  - サブアイテム
1. 第一項目
2. 第二項目

リンクと画像

[リンクテキスト](http://example.com)
![代替テキスト](http://example.com/image.jpg)

Markdownの活用例

Markdownは、以下のような場面で活用されています。

  • ブログの投稿: Markdownを使用して、記事を簡単にフォーマットできます。
  • ドキュメント作成: READMEファイルや技術文書の作成に適しています。
  • オンラインフォーラム: ユーザーがコメントや投稿を行う際に、簡単にフォーマットできます。

Markdownの標準化

Markdownの初期の仕様にはあいまいさがあり、さまざまな実装が生まれました。これを解決するために、2014年にCommonMarkという標準化された仕様が策定されました。CommonMarkは、Markdownの明確で一貫性のある仕様を提供し、さまざまなプラットフォーム間での互換性を高めることを目的としています。

Markdown完全チートシート

基本的な文字装飾

強調とイタリック

*イタリック* or _イタリック_
**太字** or __太字__
***太字とイタリック*** or ___太字とイタリック___
~~打ち消し線~~

イタリック or イタリック
太字 or 太字
太字とイタリック or 太字とイタリック
打ち消し線

見出し

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

リスト

箇条書きリスト

- アイテム1
  - サブアイテム1
  - サブアイテム2
- アイテム2
- アイテム3

または

* アイテム1
  * サブアイテム1
  * サブアイテム2
* アイテム2

番号付きリスト

1. 最初のアイテム
2. 2番目のアイテム
   1. サブアイテム1
   2. サブアイテム2
3. 3番目のアイテム

チェックリスト

- [x] 完了したタスク
- [ ] 未完了のタスク
- [ ] もう一つのタスク

リンクと画像

リンク

[リンクテキスト](https://www.example.com)
[タイトル付きリンク](https://www.example.com "タイトル")
<https://www.example.com>

画像

![代替テキスト](画像のURL)
![代替テキスト](画像のURL "画像タイトル")

コードブロック

インラインコード

`インラインコード`

コードブロック

```
複数行の
コードブロック
```

```python
# シンタックスハイライト付き
def hello_world():
    print("Hello, World!")
```

| 左寄せ | 中央寄せ | 右寄せ |
|:-------|:--------:|--------:|
| 内容1   | 内容2    | 内容3   |
| セル1   | セル2    | セル3   |
左寄せ 中央寄せ 右寄せ
内容1 内容2 内容3
セル1 セル2 セル3

引用

> 引用文
>> ネストされた引用
>>> さらにネスト

引用文

ネストされた引用

さらにネスト

水平線

---
***
___

その他の要素

脚注

ここに脚注へのリンク[^1]があります。

[^1]: これが脚注の内容です。

定義リスト

用語1
: 定義1
: 定義2

用語2
: 定義3

エスケープ文字

\*文字通りのアスタリスク\*
\`文字通りのバッククォート\`
\[文字通りの角括弧\]

拡張Markdown記法(プラットフォーム依存)

テーブル拡張

| 機能 | 説明 | サポート |
|------|------|:--------:|
|セル結合|>|対応|
|行結合|^|対応|

数式(MathJax/KaTeX)

インライン数式: $E = mc^2$

ブロック数式:
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$

Mermaid図表

```mermaid
graph LR
    A[四角形] -->|矢印| B(丸型)
    B --> C{ひし形}
    C -->|はい| D[/平行四辺形/]
    C -->|いいえ| E[\逆平行四辺形\]
```

ベストプラクティス

  1. 見出しの前後には空行を入れる
  2. リストアイテムは一貫した記号(-*)を使用
  3. ネストされたリストはスペース2個でインデント
  4. リンクや画像のURLは相対パスを使用(可能な場合)
  5. コードブロックには言語指定を付ける
  6. 表は整形して視認性を高める

エディタ固有の機能

多くのMarkdownエディタでは以下の機能がサポートされています:

  • ライブプレビュー
  • カスタムCSSの適用
  • エクスポート(PDF, HTML, etc.)
  • カスタムテンプレート
  • スニペット機能
  • ショートカットキー

共通の問題と解決策

改行

  • 文末に半角スペース2つ
    または
  • 段落間に空行を入れる

リスト内のコードブロック

リストレベル+4スペースでインデント:

  1. リストアイテム

    def example():
        return True
    

画像サイズの指定

<img src="image.jpg" width="200" height="100">

HTMLの埋め込み

多くのMarkdownパーサーは基本的なHTMLタグをサポート:

<div align="center">
  <p>中央寄せテキスト</p>
</div>

まとめ

Markdownは、シンプルでありながら強力なマークアップ言語で、さまざまな用途で利用されています。基本的な構文を覚えれば、すぐにでもMarkdownを使い始めることができます。Markdownを使用することで、文書作成の効率を高め、読みやすいコンテンツを提供することができます。Markdownを使った記事やドキュメント作成に挑戦してみましょう。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?