メインコンテンツにスキップ

プロジェクトの説明をMarkdown(マークダウン)で書く方法

Magmaのプロジェクトの説明はMarkdownで書けます。見出し、強調、リスト、リンク、画像の書き方を例つきで紹介します。

対応者:Wojtek Jodel

Magmaでは、プロジェクトに説明を追加して、他のユーザーに背景や情報を伝えられるようになりました。

プロジェクトの説明欄では、Markdown(マークダウン)が使えます。Markdownは、テキストを簡単に整形できる軽量マークアップ言語です。次の書き方で、わかりやすいプロジェクトの説明を作れます。

見出し

行の先頭に「#」を1つ以上付けると見出しになります。「#」の数で見出しのレベルが決まります。

「#」とテキストの間には、必ず半角スペースを入れてください。

例:

# これはレベル1の見出しです
## これはレベル2の見出しです
### これはレベル3の見出しです

強調

テキストを斜体にするには、強調したいテキストの前後に「*」または「_」を1つずつ付けます。例:

これは *強調された* テキストです。
これは _強調された_ テキストです。

テキストを太字にするには、前後に「**」または「__」を付けます。例:

これは **太字** テキストです。
これは __太字__ テキストです。

リスト

行頭に「*」か「-」と半角スペースを付けると、箇条書きになります。数字とピリオド(.)、半角スペースを付けると、番号付きリストになります。例:

* 項目1
* 項目2
* 項目3

1. 1つ目の項目
2. 2つ目の項目
3. 3つ目の項目

リンク

リンクにするテキストを「[ ]」で、URLを「( )」で囲むと、リンクを作成できます。例:

これは[リンク](http://www.example.com)です。

画像

「!」に続けて、代替テキストを「[ ]」で、画像のURLを「( )」で囲むと、画像を追加できます。例:

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

これで完了です。この基本的な書き方を使って、Magmaのプロジェクトにわかりやすく整った説明を付けてみましょう。

こちらの回答で解決しましたか?