LoginSignup
18
17

More than 5 years have passed since last update.

Markdownアンチパターン

Last updated at Posted at 2014-09-09

いろいろあるけど、思ひついたら足してく

http://qiita.com/tadsan/items/6fb4523eb87102496628.md でこの記事の原文が見られるよ

見出し

見出し/小見出しをつけない

  • 文章の区切りがわかりにくい

■変な記号を見出し代りにする

  • 誰も得しない

リスト記法

変な記号をリスト記法の代用にする

・りんご
・バナナ
・みかん

1) 東京都
2) 大阪府
3) 京都府

ソースコード

コード記法使はない

  • だめなやつ
    • dir 変数でディレクトリを参照する
  • こうしたかった
    • __dir__ 変数でディレクトリを参照する

コードブロック使はない

<?php $n = trim(fgets(fopen('php://stdin', 'r')));
for ($i = 1; $i <= $n; $i++) {
if ($i % 3 === 0) { ?>Fizz<?php }
if ($i % 5 === 0) { ?>Buzz<?php }
elseif ($i % 3 !== 0) echo $i;
?>

<?php
}

  • なんか変な空行入ってる
  • インデントが反映されない
  • Qiitaだと数式と衝突して盛大に壊れる

コードブロック使はない 2

<?php

class Git extends \SebastianBergmann\Git
{
public function getCurentHash()
{
$this->execute('git rev-parse --verify HEAD', $output, $return);

    if (!isset($output[0])) {
        throw new \RuntimeException;
    }

    return $output[0];
}

}

  • 空行がみっともない上に、コードブロック記法と衝突して変な感じになってる
  • Qiitaだと数式と衝突してすごい変な感じになる

段落/改行

文中で改行する

文章中の改行をどう処理するかは、Markdownエンジンの種類とか
変換オプションによって変化する。Qiitaの場合は改行が<br>に変換されちゃうから
不用意に改行を入れるとすごい不恰好な文章になるよ。

一文ごとに段落

文章の最後につけるを句点と呼ぶ

私たちは小学校の国語の授業で、段落には意味段落と形式段落があることを習った

意味のまとまりを無視して一文ごとに段落を作ると文章が散漫とする

これはただの散文詩[ポエム]

引用

我輩は猫である。
引用文から空行を空けずに自分の文章を書く

引用の次の行には空の行がなければならない。

18
17
0

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
18
17