QA@IT

QA@ITで使えるMarkdown記法

質問や回答はMarkdown形式で入力できます。Markdownは手軽にマークアップが実現できる簡易マークアップ言語です。QA@ITで利用できるMarkdownの記法は以下のとおりです。

コードブロックの引用

コードブロックに対して、バッククオート「`」を3つ続けるとソースコードのハイライト表示ができます。このとき、先頭のバッククオートの後に言語名を指定することで、言語ごとの文法を考慮したハイライトができます。

```ruby
# Sample code.
require 'active_support'
class Qatmarkit < Atmarkit::Base
  def hello
    @hello ||= "hello"
  end
end
```

と入力すると、以下のように表示されます。

# Sample code.
require 'active_support'
class Qatmarkit < Atmarkit::Base
  def hello
    @hello ||= "hello"
  end
end

文章中でのコードの引用

ブロック単位ではなく、コード片を文章中で使う場合は、バッククオートを1つ使えば大丈夫です。

Cで文字列としてデータを表示するには `printf()` を使います。

と書けば、

Cで文字列としてデータを表示するには printf() を使います。

と該当部分が赤字で表示されます。単にMarkdown記法で使われている記号をエスケープする目的だけであれば、バックスラッシュも使えます。

リンク文字列

リンク文字列は、URLを直接書くと、それがリンクに変換されます。また、以下のように文字列に対してリンクを貼れます。

[Wikipedia](http://www.wikipedia.com/)

Wikipedia とリンクになります。

箇条書き

箇条書きは、

- ひとつ
- ふたつ
- みっつ

とすることで、

  • ひとつ
  • ふたつ
  • みっつ

と、<ul> <li> を使ったHTMLに変換されて表示されます。

数字を付けて書くと、

1. ひとつ
2. ふたつ
3. みっつ

以下のように、 <ol> <li> になります。

  1. ひとつ
  2. ふたつ
  3. みっつ

数字の並べ替えが面倒なら、

1. ひとつ
1. ふたつ
1. みっつ

1. ひとつ
3. みっつ
2. ふたつ

としても結果は同じになります。

強調表示

文字列の強調には、アスタリスク ** を使って囲みます (前後の文との間には半角スペースが必要です)。

これを実行するには、 **root権限が必要** です

と書けば、

これを実行するには、 root権限が必要 です

と表示されます。

段落見出し

# 見出し
## 小さい見出し
### もっと小さい見出し

というように、HTMLのヘッダ要素のように見出しを付けることもできます。それぞれ<h1> <h2> <h3> に変換されます。ただし、本文ではなるべく<h2> 以下のヘッダを使ってください。

ドキュメントなど文章の引用

文章の引用 (blockquote) は、> を行頭に付けることで行えます。

> QA@ITは、質問・回答を共有し、編集していくことで、
> ベストなQA集を蓄積するための、ITエンジニア向けの
> 質問・回答コミュニティです。

とすることで、

QA@ITは、質問・回答を共有し、編集していくことで、
ベストなQA集を蓄積するための、ITエンジニア向けの
質問・回答コミュニティです。

と表示されます。改行なしの1行とすれば、先頭に1つだけ > を付ければ大丈夫です。

> QA@ITは、質問・回答を共有し、編集していくことで、ベストなQA集を蓄積するための、ITエンジニア向けの質問・回答コミュニティです。

というのは、

QA@ITは、質問・回答を共有し、編集していくことで、ベストなQA集を蓄積するための、ITエンジニア向けの質問・回答コミュニティです。

と表示されます。