Markdown => 方言/味

備考

構文が異なるMarkdownのバリエーションを「フレーバー」と呼びます。マークダウンのフレーバーはhttps://github.com/jgm/CommonMark/wiki/Markdown-Flavorsに掲載されています。

Markdownフレーバは、さまざまなプログラミング言語およびソフトウェアアプリケーションで実装できます。 Markdownパーサーを実装するライブラリは、 https://github.com/markdown/markdown.github.com/wiki/Implementationsおよびhttps://www.w3.org/community/markdown/wiki/MarkdownImplementationsにリストされています。

いくつかのMarkdownフレーバーとその違いは、 http://flavoredmarkdown.comに記載されています。

多くの異なるフレーバーでMarkdownコードをテストして比較するには、これらのフレーバーの実装で、オンラインツールBabelmarkを使用できます。

スタックオーバーフローのマークダウン

スタックオーバーフローや他のスタックエクスチェンジサイトで使用されているマークダウンの味です。あなたが質問に答えるか文書を追加するときは、このマークダウンを使用します。この答えは、SOのマークダウンから作られています

公式ドキュメントを見る

SOマークダウンが追加する主なものは、そのWebページ上の「スタック交換の追加」です。具体的には、SOのようなタグ追加[tag:tag]などのショートカットリンク[meta] （いないドキュメントにかかわらず）、 スポイラーを ：

これはスポイラーです

>! This is a spoiler

カスタム言語の祈り

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygenは、Markdownの使用もサポートする、C ++、C＃、Javaなどの一般的なコードドキュメントツールです。標準Markdown構文に加えて、いくつかのDoxygen固有の要素があります。

主な機能は、参照に@refタグを使用することと、参照できる@section/@subsection @page 、 @section/@subsection 、 @section/@subsection @anchor要素です。

@ref <name> ["text"]

この要素は、ドキュメンテーションの別の場所で定義されている名前付きセクション、サブセクション、ページ、またはアンカーへのリンク（つまり参照）を作成します。（ Doxygen参照を参照）

最初のパラメータ（ name ）は、リンクするセクション、サブセクション、ページ、またはアンカーの名前と一致する必要があります。

2番目のオプションのパラメータ（ "text" ）は、二重引用符で囲んで、参照リンクがページに表示される内容を定義します。使用しない場合、リンクは参照で使用されるタイトルとして表示されます。

@section <section-name>（セクションタイトル）

この要素はセクション名を定義します。これはMarkdownの#要素と視覚的に同等ですが、ドキュメントの他のセクションからリンクできる参照を定義します。（ Doxygen参照を参照）

最初のパラメータsection-nameは、 @ref要素で使用できる参照名を定義します。スペースは使用できません。

2番目のパラメータsection titleは、ページ上にセクション見出しがどのように表示されるかを定義する単語の文字列（スペースで区切ることができます）です。

例

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

出力

前書き

これは私の紹介のテキストです。

ボディ段落

これは私の体の一部のテキストです。ここで私はIntroductionを参照しています。

注意：上記のIntroductionという単語は、Introductionの見出しにジャンプするリンクとして表示されます。

GitHub Flavored Markdown

GitHub Flavored Markdown （時にはGFMと略記される）では、 GitHub.comでのmarkdownの操作が簡単になります。

GFMの主な機能は次のとおりです。

コードインデント
タスクリストのサポート
簡単なGitHubの問題の参照
自動GitHubユーザ名とSHA検出
自動URL検出
絵文字のサポート

GFMの例

シンタックスハイライト

Markdownを使用すると、3つのバッククォートでコードブロックを生成できます。

```

構文強調表示がなければ、Cで書かれたコードは次のようになります

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

しかし、構文の強調表示して、Cで書かれたコードは次のように表示されます：

コードを強調表示するには、オプションの言語識別子を追加して、分離コードブロックで構文の強調表示を有効にするだけです。

```C
<code text here>
```

これらの機能拡張は、 READMEファイル、要点、プルリクエスト、およびプラットフォーム上の問題に含まれるドキュメントおよび会話の質を向上させるように設計されています。

Modified text is an extract of the original Stack Overflow Documentation

ライセンスを受けた CC BY-SA 3.0

所属していない Stack Overflow

Markdown
方言/味

サーチ…

備考