今回がQiita初投稿になります。よろしくおねがいします。
####「プログラミング知識をMarkdown記法で書いて共有しよう」
と、Qiitaの投稿画面の一番初めにもデフォルトである通りQiitaにしろREADMEにしろGitHubのプルリクエストにしろプログラミング業界ではMarkdown記法というのがちょいちょい出てくるんですね。
自分も初めの頃は参考のサイトを見て少しやろうと思いましたが、案外やり方が多くて面倒になり別にまだ覚えなくてもいいかと思っていたのですが最近になり少しずつやり方が分かってきたので備忘録的な意味と自分の練習もかねて投稿しようと思いました。
まず初めにMarkdownについてですが
##Markdownとは
Markdown(マークダウン)は文章を記述するための記法(マークアップ言語)の1つです。
Markdownとは、メールを記述する時のように書きやすくて読みやすいプレーンテキストをある程度見栄えのするHTML文書へ変換出来るフォーマットとしてジョン・グルーバーによって開発されました。
以下の特徴があります。
- 簡単で覚えやすい記述
- 文章の構造を明示出来る
- Markdownそのままでも理解出来る
- 対応アプリを使うことでより快適に読み書き出来る
- 拡張子は「.md」
とのことです。
例として以下にRailsのアプリケーションのREADMEの一例を載せます。
README
users テーブル
| Column | Type | Options |
|---|---|---|
| user_name | string | null: false |
| string | null: false | |
| password | string | null: false |
Association
- has_many :friends
- has_many :comments
というようにアプリケーションにはREADMEが必須でありその中の記述はMarkdown記法のためMarkdown記法を最低限は覚える必要があるということですね。
では自分がよく使うものを抜粋して紹介します。
-
「＃」を先頭に入れて半角スペース1つ分空けると見出しの意味になり大文字になり強調されます。(h1タグと同じ意味)
「＃」が一番大きくて以下1つずつ増やすごとに大文字がだんだんと小さくなり「＃＃＃＃＃＃」最大6つまで連続で記述出来ます。 -
「-」を先頭に入れて半角スペース1つ分空けると「・」が付与されます。
-
「---」と「-」を3つ以上連続で入れると水平線が出来ます。
と上記が自分がよく使用している記述でした。上記の記述方法は本当にほんの一部なので興味のある人はちゃんとしたサイトから学習頂ければと思います。(笑)
と言ってもQiitaにいる人達はみんなMarkdown記法で記事を投稿しているのだから恐らくQiitaに投稿した人の中で自分が一番Markdown記法を知らない(使いこなしていない)と思いますのでこれから精進して参りたいと思います。ここまでお付き合い頂きありがとうございました。
注：Markdown記法の「#」や「-」などは全て半角で記述しないと正しく反映されません。さらには半角スペースも1つ分空けてください。全角では反映されませんので注意！