エミ眠太の自由帳
 エミ眠太の自由帳
    
 
 基本      2022-03-06      2023-06-11

Markdownの書き方とPros & Cons

Language:
 Markdown
Framework/Library:
Technology:
Platform/Tool:

記事一覧へ

目次


はじめに

MarkdownはQiitaやTumblr等様々なメディアにおいて標準的な記述スタイルとして使われていますが、慣れれば使いやすい一方使わないとすぐ忘れてしまうのが玉に瑕。というわけでチートシート的なものを作りましてん。

What is Markdown?

そもそも

Wikipediaによると、HTMLをはじめとしたマークアップ言語を簡素化したもので、誰でも簡単にウェブ上で文章を書けるようにした記法ということで覚えておけば大丈夫かと思います。文章を書く際に、いちいち<>で括るの面倒ですものね。

Pros & Cons

ここで、良い点・悪い点をまとめてみます。このセクションは飛ばしてもらっても全く問題ありません。

Pros

  1. HTMLタグ使用可能:

    • Markdown記法をしっかりと覚えていなくても、一応HTMLが使えます。一番目に書く事ではない。
  2. 記述スピードの高速化:

    • HTMLタグは基本<>で括ります。あれかなり面倒ですよね。Markdownであれば普段からキーボード操作で使用する()や*等の記号を使って文章を作成するため、比較的直感的にかつ高速に記述することができます。
  3. スタイルを引き継がない:

    • 他サイトからコピー&ペーストをしても、スタイルが引き継がれないので、楽にコピー&ペーストができ文章作成の効率化につながります。

Cons

  1. タイポが増える場合がある:

    • 若干個人的意見が混じりますが、Markdown記法では記号を頻繁に使用しますが、HTMLと違ってタグを使用しない分、タイポに気づくのに時間がかかりがちです。ブラウザの「検証」で確認すればMarkdownもHTMLに変換されるのでタイポに早く気づけると思います。
  2. 全てのHTMLタグをMarkdownに置き換えられるわけではない:

    • Prosの1つ目の裏返しですが、覚えたは良いが全要素を置き換えられるわけではないので、HTMLとMarkdownが混在してしまいかえって使いづらいと感じることもあるかもしれませんね。

Markdownの代表的なもの(対応表)

お待たせしましたチートシートです。 下表のものはよく使うので覚えておくと楽だと思います。ちなみにこのチートシート自体もMarkdownで記述しています。

項目 HTML Markdown
見出し <h1>見出し1</h1>
<h2>見出し2</h2>
<h3>見出し3</h3>
<h4>見出し4</h4>
<h5>見出し5</h5>
<h6>見出し6</h6>
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
太文字 <strong>太文字</strong> ** 太文字 **
イタリック <em>イタリック</em> *イタリック*
太文字+イタリック <strong><em>太文字イタリック</em></strong> ** *太文字イタリック***
引用 <blockquote>引用</blockquote> > 引用
打ち消し・取り消し <del>打ち消し・取り消し</del>
<s>打ち消し・取り消し</s>
~打ち消し・取り消し~
エスケープ <要素>文字列</要素> \要素
コード <code>console.log(2022)</code> `console.log(2022)`
順序のあるリスト <ol>
<li> ひ </li>
<li> ふ</li>
<li> み</li>
<li> ん</li>
</ol >
1. ひ
2. ふ
3. み
4. ん
順序のないリスト <ul>
<li> ひ </li>
<li> ふ</li>
<li> み</li>
<li> ん</li>
</ul >
* ひ
* ふ
* み
* ん
リンク <a href="http://www.yahoo.co.jp/">Yahoo</a> [Yahoo](http://www.yahoo.co.jp/)
下線、水平線 <hr> ---
___
***

まとめ・参考

他にもまだまだMarkdown形式で表現できるものはありますが、詳しくは以下ガイド参考にしてみてください。

参考


記事をシェアする


関連する記事

よろしければこちらの記事も参考にしてみてください。

Loading...




記事一覧へ