スタッフブログ

STAFF BLOG

アプリ開発日誌

2016.06.28

Markdownを活用しよう!

こんにちは、iOS開発担当の松川です。

今日は最近よく使うようになったMarkdownの書き方について書きたいと思います!

皆さんはMarkdownをご存知でしょうか?

Markdownとは

Markdown は、文書を記述するための軽量マークアップ言語のひとつである。
「書きやすくて読みやすいプレーンテキストとして記述した文書を、妥当なXHTML(もしくはHTML)文書へと変換できるフォーマット」として、ジョン・グル―バー(John Gruber)とアーロン・スワーツ(Aaron Swartz)によって考案された。
Markdownの記法の多くは、電子メールにおいてプレーンテキストを装飾する際の慣習から着想を得ている。

Markdown – Wikipedia

HTMLは見た目をリッチに書く事はできますが、直接書くのは可読性が悪いですよね・・・。

そこで、このMarkdown記法を習得できればお手軽にリッチな文章を作成できます!

メモやブログや設計書を作成する上でも役立つと思うので、ぜひお試しください!

Markdownを書けるエディタ

Markdownを書けるエディタは様々出回っていますが、今回は僕が使用している「Atom」を使って紹介します。

※エディタによって書き方や、書けるものが違ったりするので注意してください

他にも触った事のある有名なエディタを紹介

Markdownのプレビューを表示

Atomを開いたら「control + shift + M」でMarkdownのプレビューが表示できます!

見出し

「# 半角スペース」で見出しを作成できます。

また「#」の数によって見出しのサイズを変更できるので、小項目・中項目などに使用できます

見出し

改行

文章の最後に「半角スペース + 半角スペース」で改行できます

改行

リスト

「- 半角スペース」と書くとリスト化されます!

また、リストの次の行で「タブ – 半角スペース」と記入するとリストの下にリストを作成できます。

「-」ではなく、「数字.」と記載すると、数字でリスト化されます!

リスト

数字リスト

引用

「> 半角スペース」と書くと、その行が引用行になります。

引用

コードブロック

「` ` `」で上下を挟むと、その間がコードブロックになります。

qiitaに投稿する時など大変お世話になります。

コードブロック

テーブル

一行目にタイトル、二行目にalignmentを選択し、三行目以降にデータを記載します。

APIの設計書などによく使います。

【alignment】左寄せ(:-)中寄せ(:-:)右寄せ(-:)

テーブル

リンク

「[リンクにする文字列](リンク先URL)」でリンク化できます。

画像に関してはリンクの先頭に「!」をつけると表示できます!

リンク

画像リンク

備考

  • 初期はテキストの形式がPlain Text(右下)になっていますが、ここをクリックすると言語別に設定を変更できます
  • プレビュー画面を右クリックするとHTMLファイルとして出力する事もできます

どうだったでしょうか?

以上がMarkdownの書き方になります。

Markdown記法を覚えると、お手軽にリッチな文章やwikiが作成できるので皆さんもぜひ使ってみてはどうでしょうか!

※より深くMarkdown記法について知りたい方は、こちらのMarkdown記法の原文をご覧ください

BACK

お問合せ

イーディーエーに興味をお持ちいただいて
ありがとうございます!
スマホアプリに関するご相談、
お見積りや弊社へのご質問など、
お気軽にお問い合わせください。
担当者より折り返しご連絡させていただきます。

    お名前必須
    会社名
    メールアドレス必須
    電話番号必須
    お問合わせ種別必須
    お問合わせ内容必須

    アンケートにご協力ください。
    弊社サイトへはどのようにしてアクセスされましたか?

    個人情報のお取扱いに関する同意事項

    1.事業者の氏名又は名称

    株式会社イーディーエー

    2.個人情報保護管理者の氏名又は職名、所属及び連絡先

    個人情報保護管理者 木下 晴晶
    Mail:[email protected]

    3.取得した個人情報の利用目的的

    当フォームで取得した個人情報は、お問い合わせに関する回答のために利用し、目的外利用はいたしません。

    4.弊社が取得した個人情報の第三者への委託、提供について

    弊社は、ご本人に関する情報をご本人の同意なしに第三者に委託または提供することはありません。

    5.個人情報保護のための安全管理

    弊社は、ご本人の個人情報を保護するための規程類を定め、従業者全員に周知・徹底と啓発・教育を図るとともに、その遵守状況の監査を定期的に実施いたします。
    また、ご本人の個人情報を保護するために必要な安全管理措置の維持・向上に努めてまいります。

    6.個人情報の開示・訂正・利用停止等の手続

    ご本人が、弊社が保有するご自身の個人情報の、利用目的の通知、開示、内容の訂正、追加又は削除、利用の停止、消去及び第三者への提供の停止を求める場合には、下記に連絡を頂くことで、対応致します。

    株式会社イーディーエー 個人情報お問合せ窓口
    〒106-0032 東京都港区六本木7丁目14番23 ラウンドクロス六本木4F
    TEL:03-5422-7524 FAX:03-5422-7534
    Mail:[email protected]

    7.ご提供いただく情報の任意性

    個人情報のご提供は任意ですが、同意を頂けない場合には、第3項にあります利用目的が達成できない事をご了承いただくこととなります。

    8.弊社Webサイトの運営について

    弊社サイトでは、ご本人が弊社Webサイトを再度訪問されたときなどに、より便利に閲覧して頂けるよう「クッキー(Cookie)」という技術を使用することがあります。これは、ご本人のコンピュータが弊社Webサイトのどのページに訪れたかを記録しますが、ご本人が弊社Webサイトにおいてご自身の個人情報を入力されない限りご本人ご自身を特定、識別することはできません。
    クッキーの使用を希望されない場合は、ご本人のブラウザの設定を変更することにより、クッキーの使用を拒否することができます。その場合、一部または全部のサービスがご利用できなくなることがあります。