Blog 技術解説

Markdown完全ガイド - エンジニアの文書術

Markdownの基本文法からGitHub Flavored Markdownの拡張機能まで、エンジニアに必要な文書作成スキルを網羅します。

2 min read [AI生成]

はじめに

Markdownはエンジニアにとって最も身近な文書フォーマットです。README、設計書、ブログ記事、Slackメッセージまで、あらゆる場面で使われています。

基本文法

見出し

# H1 見出し
## H2 見出し
### H3 見出し

テキスト装飾

**太字**
*斜体*
~~取り消し線~~
`インラインコード`

リスト

- 箇条書き1
- 箇条書き2
  - ネスト

1. 番号付き1
2. 番号付き2

リンクと画像

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

コードブロック

バッククォート3つで囲みます。言語名を指定するとシンタックスハイライトが効きます。

```javascript
const hello = () => console.log("Hello!");
```

テーブル

| 項目 | 説明 |
|------|------|
| A    | 説明A |
| B    | 説明B |

GitHub Flavored Markdown (GFM)

タスクリスト

- [x] 完了したタスク
- [ ] 未完了のタスク

注釈(Alerts)

> [!NOTE]
> 補足情報

> [!WARNING]
> 注意事項

実務でのTips

1. READMEの構成

# プロジェクト名
## 概要
## インストール
## 使い方
## 開発方法
## ライセンス

2. 設計書でのMermaid活用

```mermaid
graph LR
    A[ユーザー] --> B[フロントエンド]
    B --> C[API]
    C --> D[データベース]

## まとめ

Markdownは覚えることが少なく、すぐに使い始められます。日常的に使うことで自然と身につくので、まずはREADMEやメモから始めてみましょう。
Share

Comments / コメント

コメント