エンジニアの知恵袋

エンジニアの知恵袋

フリーランスシステムエンジニアをしています。日々感じたことや学んだことをアウトプットしていきます。

Markdown(マークダウン)記法

Markdown(マークダウン)記法とは

Markdown(以下マークダウン)記法とはwikiやプロジェクト管理ツールなどにおいてテキストの文章を書くときに簡単に見出し、箇条書き、フォントなどを装飾できる記述方法ですね。 お恥ずかしいことに今のプロジェクト入るまでは私は知りませんでした。 このブログもマークダウン記法を使用して記載しています。

エクセルやワードみたいにいちいち文字やセルを選択して装飾しなくて良いので便利ですよね。 Redmineだったり、Backlogだったりのプロジェクト管理ツールや、AWSなどでも使用されているようで、用途はかなり多そうなので覚えておいて損はなさそうです。

私も忘れがちなのでここにまとめておきたいと思います。

マークダウンの主な種類

私が主に使用頻度が高いマークダウン記法のルールを列挙します。

記号 意味
**テキスト** 太字
~~テキスト~~ 取り消し線
# テキスト 見出し。行頭に付ける。
#の数を増やすごとに見出しレベルが下がる
* テキスト 箇条書き。行頭に付ける。
スペースを4つ開けるごとに
インデントを下げられる
1. テキスト 番号付きの箇条書き。
数字はカウントアップする必要がない。
> テキスト 引用
`テキスト` インライン。テキストこんな感じで単語が
コピーしやすくなる
```
テキスト
```
コードブロック。ソースコードなど
貼るときにとても便利
[テキスト](リンク
もしくはアンカー)
リンク。一つ目の見出しへ
|ヘッダー1|ヘッダー2|
|--|--|
|テキスト|テキスト|
テーブル。結構忘れやすい。
「--」の前後に「:」を付けると
文字位置調整できる

ざっとこの辺りを覚えておけばやって行けるかと思います。 積極的に色々使いながら覚えていきましょうか。