LoginSignup
8
6

More than 5 years have passed since last update.

Qiita Markdown 記述メモ

Last updated at Posted at 2018-09-03

Qiitaに投稿するに当たってどのように書けばいいかわからなかったので、
投稿の仕方も兼ねて、個人的に使いそうな書き方をピックアップし、まとめた。

以下を参考
Markdown記法 チートシート

コード挿入

(空行)
```{言語}:{ファイル名}
コード内容
```
(空行)

言語を指定することでシンタックスハイライトが適用される。

コード挿入 例

```java:test.java
System.out.println("hoge");
```

test.java
System.out.println("hoge");

見出し

  • # H1タグ
  • ## H2タグ

右側に出てくる目次にも影響が出てきそうなので、
基本的には、

## で1ブロックの見出し、
### でブロック内での見出しとするのが適切そうか。

強調・打ち消し線

強調

__ か、 ** で囲むと、太字になる。

打ち消し線

~~ で囲むと、打ち消し線 となる。

リスト

Disc型

  • 文頭に *, + , - いずれかを入れる。
  • tab キーでスペースを挿入すれば、入れ子構造にもできる。

Disc型 例

  • hoge
    • huga
    • piyo
      • ほげ
        • ふが
          • ぴよ

Decimal型

  • 文頭に 数値. を入れる
  • 後から追加するなどを考慮して 1.2.3 のようにするのではなく、 1.1.1 のように同じ数字にしておくのが良い書き方らしい。(補完機能でインクリメントされるみたいだが...)

Decimal型 例

  1. hoge
    1. ほげ
    2. ふが
  2. huga
  3. piyo

引用

  • 文頭に > を置くことで引用となる。
  • 複数行にまたがる場合は、改行のたびに > を置く必要あり
    • 上記は誤り。改行のたびに > は不要
    • 途中空行が含む場合のみ > を置く
> 1行目
2行目
3行目

1行目
2行目
3行目

> 1行目
2行目
3行目
>
5行目

1行目
2行目
3行目

5行目

水平線

下記はすべて水平線として表示される。

* * *
***
*****
- - -
---


リンク

  • [リンクテキスト](URL "タイトル")

リンク 例

[Qiita](http://qiita.com "Qiita")
Qiita

画像埋め込み

  • ![代替テキスト](画像のURL "画像タイトル")

画像埋め込み 例

![Qiita](https://qiita-image-store.s3.amazonaws.com/0/45617/015bd058-7ea0-e6a5-b9cb-36a4fb38e59c.png "Qiita")
Qiita

Qiita上であればドラック&ドロップで自動で生成してくれるのであまり気にする必要無いかも。

テーブル

参考サイトによると、入力補完できるらしいが、動かなかった。

手動で入力する方法

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       | This        | This         |
| column     | column      | column       |
| will       | will        | will         |
| be         | be          | be           |
| left       | right       | center       |
| aligned    | aligned     | aligned      |

Left align Right align Center align
This This This
column column column
will will will
be be be
left right center
aligned aligned aligned

注釈

文中に[^1][^example]のように文字列を記述することで、脚注へのリンクを表現できます。注釈内容は、同じく本文中に [^1]: ...というように記述します1


  1. 注釈内容を記述する位置は、本文の途中でも末尾でも構いません。 

8
6
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
8
6