Githubを使っている人は、README.mdを必ず書いていると思います。（書いてない人もいるかも・・・）
マークダウン(Markdown)書式は、書き慣れると非常に整理した文章が書けます。
プレビューで見ると、簡素ですがデザイン適用することもできます。
エンジニアたるもの、md書式に書き慣れておくことは、重要なスキルの一つでもあると考える様になりました。
これを利用すれば、Githubでは、ブログのような記事公開をすることもできるし、
Obsidianを始め、GoogleKeepなど、全ての機能を網羅してはいないですが、md形式で書くことでそれなりの見た目にすることもできます。
あと、SlackやGoogleSpaceなどのチャットアプリでも、md形式記述がある程度イケますね。
マークダウンがわからない人、苦手な人、食わず嫌いの人、そんな人に向けて今回のブログを書いてみました。
※マークダウンの詳細を説明する内容ではないです。
Markdownの何が便利なの？
そもそもMarkdownって、HTMLに変換をするための予備コードだと考えてください。
#が、h1タグで、
##が、h2タグで、
###が、h3タグ
- aaa
- bbb
こう書くと、
<ul>
<li>aaa</li>
<li>bbb</li>
</ul>
このように変換されてプレビューされます。
上記の応用で、
1. aaa
2. bbb
これで
<ol>
<li>aaa</li>
<li>bbb</li>
</ol>
こうなります。
別にHTMLを意識しなくても、項目や数値、見出しが先頭に来ているので、テキストデータだけでも十分に理解できます。
Markdownを知らないサラリーマンがエクセルではなく、テキストファイルを書きた場合に、次の様な書き方をします。
◆本日のアジェンダ
①サマリー
②内容の説明
③お見積もり内容
別にこれでも悪くはないんですが、mdだと次の様になります。
# 本日のアジェンダ
1. サマリー
2. 内容の説明
3. お見積もり内容
エンジニアという人種はできるだけ全角文字列を使いたくないという思考を持っています。（エンジニアあるある）
できれば、内容の日本語表記も英語で書きたい人も少なくないとかあるとか・・・
Markdownの魅力について
色々なアプリに対応できると言う魅力は大きいのですが、その他のMarkdownの魅力についてChatGPTに考えてもらいました。
シンプルさが最大の魅力
Markdownはシンプルな書式でありながら、強力な機能を持っています。
基本的なテキストエディタだけでリッチな文書を作成できます。
余計なツールや複雑な設定が不要なので、誰でも簡単に学べ、使いこなせます。
多用途に対応
Markdownはブログ記事やドキュメント、プレゼンテーション、メモ作成など、多くの用途に対応しています。
また、GitHubやBitbucketのようなプラットフォームでも標準でサポートされており、エンジニアにとっても馴染み深い言語です。
可読性の高さ
Markdownは書き手にとっても読み手にとっても、可読性が非常に高いです。
タグが少なく、テキストに近い形式で書けるため、後で読み返したり修正したりするのが容易です。
HTMLとの互換性
MarkdownはHTMLに変換できるため、Webページのコンテンツ作成にも適しています。
」さらに、HTMLタグを直接埋め込むことも可能なので、よりカスタマイズされた表現も可能です。
拡張性とコミュニティのサポート
Markdownには豊富な拡張機能があり、プラグインを使えば数式の記述やダイアグラムの挿入も簡単です。
オープンソースコミュニティが活発に支援しているため、新しい機能やツールが次々と登場しています。
Markdownの極意
個人的には、Githubブログを公開してもいいんですが、GoogleBloggerで、MarkDown形式で記述できるようにカスタマイズしようを考えています。
あと、メモ帳などの整理の時に、Markdownで書いていると検索性も高まること間違いなしです。
いろいろなテキストを書く時に、色々な記号を使ってワケがわからなくなるところが、Markdownでかかれていると一定のルールにのっとって、いつ書いたドキュメントでも読みやすくなると思います。（コレホント）
あとがき
最近では、毎日おっ手伝いしている会社さんの作業メモをMarkdownで書いているんですが、請求書を作るときや、
過去の作業内容を検索する時など、非常に便利に調べることができます。
むしろエンジニア以外の人たちに、Markdownを使ってもらいたくて今回のブログを書いてみました。
あなたはいつまで、①の記号を使い続けますか？
0 件のコメント:
コメントを投稿