BehaviorCloud Logo
Markdown

Markdown入門ガイド

Markdownは、コンテンツのライティングを簡素化するためのシンプルな言語です。GitHubからノートアプリまで、さまざまな場面で使われています。ライターや開発者、Webのライティングをシンプルにしたい人のためのこのガイドをご紹介します!

Markdownとは?

Markdownは、2004年にJohn Gruberによって開発された、プレーンテキストエディタでのフォーマット済みテキストを容易に読み取れるように設計された軽量マークアップ言語です。ブログ、インスタントメッセージ、フォーラム、協同作業ツール、ドキュメンテーション、READMEファイルなどで非常に人気があります。その解釈におけるバリエーションが時間の経過とともに増えてきたため、2014年にCommonMarkという、一貫性のある実装を保証するためのテストセットを備えた明確な仕様が作成されました。

基本的な構文

よく使う要素の簡単な概要を以下に示します。

1. ヘッダ

ヘッダは#記号とスペースを使って作成します:

# これはH1 
## これはH2 
### これはH3

2. 強調表示

イタリック のために、*アスタリスク* または _アンダースコア_ を使用します。

太字のために、**二重アスタリスク** または __二重アンダースコア__ を使用します。

3. リスト

順序なしリスト

アスタリスク、プラス、マイナスに続くスペースを使用します:

* 項目1 
* 項目2   
    * サブ項目2.1   
    * サブ項目2.2

順序付きリスト

数字に続くドットを使用します:

1. 最初の項目 
2. 二番目の項目 
3. 三番目の項目

4. リンク

以下の構文でインラインリンクを作成できます:

[表示テキスト](URL "オプションのタイトル")

5. 画像

画像はリンクに似ていますが、前に感嘆符が付いています:

![代替テキスト](URL "オプションのタイトル")

6. 引用

引用のために、テキストの前に > を使用します:

> これは引用です。

7. コードブロック

インラインコード のためには、バッククォートでコードを囲みます:

`ここにコード` 

複数行のコードブロックのためには、3つのバッククォートを使用します:

\```
コードの行1
コードの行2
コードの行3
\```

8. 水平線

3つのダッシュ、アスタリスク、アンダースコアで水平線を作成できます:

---

その他の便利な要素

  1. テーブル
| ヘッダ1 | ヘッダ2 | 
|--------|--------| 
| セル1  | セル2  | 
| セル3  | セル4  |
  1. タスクリスト
- [x] 完了したタスク 
- [ ] 未完了のタスク
  1. 取り消し線

~~ でテキストを取り消します:

~~取り消し~~

Markdownでの引用の書き方

Markdownファイルでは、@ 記号に続いて引用キーを使用して引用を追加できます。例えば:

最近の研究によると[@Smith2023]、その効果は...

複数の引用も使用できます:

一部の研究者はこの点を主張しています[@Smith2023; @Doe2022]。

括弧内の引用 vs. ナラティブ引用:

括弧内の引用(またはテキスト内の引用)は、著者と年を括弧内に配置します:

この現象はいくつかの研究で見られることが示されています(@Smith2023)。

一方、ナラティブ引用では、引用の著者がテキストの一部として使用されます:

Smith (2023)はこの現象を明らかにしています。

これらの引用をサポートするためには、適切なBibTeXエントリを.bibファイルに含める必要があります。

Markdownをサポートするツールとプラットフォーム

Markdownをサポートする多くのツールとプラットフォームがあります。以下はいくつかの主な選択肢です:

  • VSCode:Visual Studio Codeは、無料のプロフェッショナルなコードエディタで、多くの拡張機能を持つMarkdownサポートが含まれています。
  • Hugo:静的ウェブサイトのジェネレータで、Markdownをサポートしています。
  • Docusaurus:現代のオープンソースプラットフォームで、製品のドキュメンテーションを作成、配布、管理するためのものです。