Webサービスに文章を投稿するときにローカルで下書きしてからコピペするタイプの人が書いたQiita用記事の下書き簡易ガイド
(最終更新:2020.09.25)
書いた人の環境
- OS:macOS Catalina バージョン10.15.6
VSCodeのインストール
下記リンクからインストーラをダウンロードしてよろしくやります(詳細省略)。
Visual Studio Code
VSCodeの設定
Markdown的に正しい文書を書くためにLint(文法チェック的なもの)を入れます。
VSCode左のExtensionsをクリック
検索窓に"markdown"と打つ
"markdownlint"というエクステンションをインストール
正式なMarkdownとQiita版Markdownで改行の扱いに違いがあるので、設定でQiita版に合わせます(改行を無視せず改行として扱われるようになる)。
VSCodeの Code > Preferences > Settings を開く
検索窓に"markdown"と打つ
"Markdown > Preview: Breaks"の項目にチェックをつける
あとは、拡張子「.md」でファイルを作成してエディタ右上のプレビューマークをクリックすればプレビューを見ながらMarkdownで下書きしていけます。
よく使う記法集
「# 」ヘッダ(見出し)
- #を増やすことで見出しの階層を指定可能
「- 」順序なしリスト
- インデントすることでリストの階層を指定可能
「1. 」順序付きリスト
- インデントすることでリストの階層を指定可能
「[表示用テキスト](URL)」リンク
- "表示用テキスト"の文字でURLへのリンクを貼れる
「```code:file.ext 〜 ```」ソースコード
- バッククォート3つで挟んでソースコードを記述するとハイライトされる(Qiita上)
- コードの種類、ファイル名を指定可能
「> 」引用
- 記号の数によって引用の階層を指定可能
「\」エスケープ
- 記法自体を文字として記述することが可能
あとがき
ひとまず私がよく使うかつ忘れそうな最小限の知識をまとめてみました。
詳しい記法については公式の記事を参照するとよいでしょう。
Markdown記法 チートシート
※厳密にいうとこの記事がQiitaのガイドラインにある「プログラミングに関する知識」にあたるか微妙かもしれませんが、プログラミング上のドキュメントに関する知識の共有ということで適切だと判断した、とビビリな私は注釈を添えておきます。