Qiita 記事の書き方


はじめに

今回自分がQiitaを始めるにあたって、記事の書き方がよく分からなかったので、練習がてらここに記事の書き方について書いてみることにしました。ちなみに、この記法はMarkdown方式という書き方のようです。

見出しの付け方

ここのすぐ上にある「見出しの付け方」という見出しは、

#見出しの付け方

という風に書いています。
なお、#は半角にする必要があります。

また、#を増やすごとに見出しの大きさを小さくできます。

これは#が2つ

これは#が3つ

これは#が4つ

このような具合です。

箇条書き

・の箇条書き

  • 箇条書きテストの1
  • 箇条書きテストの2
  • 箇条書きテストの3

この箇条書きは、行頭に「*」を付け、半角空白の後、文字列を記述しています。

* 箇条書きのテストの1
* 箇条書きのテストの2
* 箇条書きのテストの3

こんな感じです。
なお、箇条書きの後には改行を入れないと、箇条書きの終わりとして判断されないようです。

数字を用いた箇条書き

  1. 数字バージョンの1
  2. 数字バージョンの2
  3. 数字バージョンの3

この箇条書きは、先程の「*」の代わりに、半角数字と「.」を使っています。

1. 数字バージョンの1
2. 数字バージョンの2
3. 数字バージョンの3

こんな感じで記述しています。

コードの記載方法

一番簡単な書き方

#include <iostream>
using namespace std;

int main()
{
  cout<<"Hello Qiita!"<<endl;
  return 0;
}

これは、ソースコードの前後を「```」(バッククオート3つ)で区切って書いています。
シングルクォーテーション「'''」ではないので注意が必要です。

こんな感じです。
バッククオートの外側は改行をそれぞれ入れておいた方が良さそうです。
改行しなかった場合、#includeのところが見出しとして判断されてしまっていました。
また、勿論自動インデント等は無いので、直接記述する際は自分でインデント等を行う必要があります。

コードに見やすく色付けする記述方法

#include <iostream>
using namespace std;

int main()
{
  cout<<"Hello Qiita!"<<endl;
  return 0;
}

これは、先程と同じようにコードを記述し、先頭の「```」の後に「cpp」と記述しています。

こんな感じです。
ここではC++のコードを用いたためcppと書きましたが、pythonやjavaなど別の言語もそれぞれ対応しているようです。

更にコードにファイル名を付ける

hello.cpp
#include <iostream>
using namespace std;

int main()
{
  cout<<"Hello Qiita!"<<endl;
  return 0;
}

これは、先程先頭のバッククオートの後に書いたcppという文字の後に、「:hello.cpp」というようにコロンとファイル名を付け加えるだけです。

リンクの作り方

私のページ
↑のようにリンクができます。
書き方は、

[私のページ](https://qiita.com/wdwd5454)

こんな感じです。
[ ]の中に、リンクとして表示したい文字列を書き、( )の中にURLを記述します。

おわりに

とりあえず自分が使えたらいいなと思った機能はこれくらいだったので、これくらいにしておこうと思います。
今後新たに必要だと思ったことがあれば追記しようと思います(できるのか知りませんが流石にできるはずです)。

参考

Qiita Markdown 書き方 まとめ