Markdown種類と記載方法

IT

Markdowmとは一体なんなのか。
ChatGPTに非エンジニアにもわかるように簡潔に教えてくれと頼んでみました。

ChatGPT様の回答>

Markdownは、テキストをシンプルで読みやすい形式で書くための軽量なマークアップ言語です。普通のテキストと同じように書けますが、特定の記号や構文を使って、テキストに書式を追加できます。例えば、テキストを太字にするには、テキストをアスタリスクで囲みます(例: **太字**)。また、リンクを挿入する場合も、[テキスト](URL)という形式で簡単に作成できます。

Markdownはエンジニア以外の人にも使いやすく、文章の見出しを作成したり、リストを作成したり、画像を挿入したりするのに役立ちます。特に、ウェブページの作成やドキュメントの共有に広く利用されています。簡単なルールに従ってテキストを整形できるため、文章を美しく表示したり、情報をわかりやすく伝えたりするのに便利なツールと言えます。

非エンジニアを入れているのに、少々分かりにくい気が。。

私がなんとなく簡単に説明すると、
日本では日本語を使用して文字を起こしていますがアメリカでは英語で文字を起こしているかと思います。どちらも文字を書き起こすと言う作業は同じであって、ただ日本語で書くか英語で書くかの違いです。

Markdownも同じような感じで、箇条書きで「・」を打ったり文字を太字にするのにwordなどで「B」というのを押下して表現しますが、それをもっと簡単に楽に描けるようにしたものがMarkdownです。少しの違いです。

→分かりにくい!

利用可能ツール

  • Teams
  • Discord
  • WordPress
  • Notion
  • VSCode
  • Qiita
  • Backlog
  • GitHub
  • Redmine
  • Mattermost

上記以外にも利用できるものはあるかもしれませんが、よくあるものはここら辺かと思います。

各種サービスによって記述方法が少しずつ違ったりしますが一回覚えてしまえば大したことはありません。

代表的なMarkdown記法についてご紹介します。
記入例と表示例は私個人PCのVSCodeで作成したものです。
実施する環境で適応されなかったり表示が若干変化することがあるのでご了承ください。

種類一覧

見出し

記述方法

表示

箇条書き

記述方法
「 – 」「 * 」「数字」どれでも箇条書きとなります。

表示

引用

記述方法
「 > 」で記載するがその個数によって引用の本数が変化する。
本数の上限はあまりなさそうです。

表示

Pre記法(整形済みテキスト)

記述方法

表示

シンタックスハイライト

記述方法
htmlでは、以下のように記載。他のpythonやrubyを指定することもできる。

表示

code記法

記述方法
「`」で囲った部分がハイライトされる。もしくは以下のように文字色が変化する。

表示

斜体(I:イタリック)

記述方法
アスタリスク「*」、アンダーバー「_」で表現します。

表示

太字(B:ボールド)

記述方法
アスタリスク「**」、アンダーバー「__」で表現します。

表示

斜体と太字(I & B:イタリック&ボールド)

記述方法
アスタリスク「***」、アンダーバー「___」で表現します。

表示

水平線

記述方法
アスタリスク「***」、アンダーバー「___」、ハイフン「—」で表現します。

表示

リンク

記述方法
[表示文字列](リンク先URL)で表現します。

表示

定義参照リンク

何度も繰り返し使用するURLがある場合に便利。または文字数の多いURLにも適している。

記述方法
[表示文字列](リンク先URL)で表現します。

表示

コメント

タイトルとURLをコピーしました