はじめに
この記事では、VSCode拡張「vscode_qiitaapi」でのテンプレートの使い方を説明します。
使い方
流れは?
拡張機能のインストールから記事投稿の更新まで
ステップ | 手順 | 内容 |
---|---|---|
1 | VSCode拡張のインストール | 拡張機能 vscode_qiitaapi を検索し、インストールする。 |
2 | Qiita APIトークンの発行 | Qiita公式のトークン発行ページから read_qiita と write_qiita を許可して発行。 |
3 | VSCodeにトークンを設定 | VSCodeの設定で qiita.apiToken にトークンを入力。 |
4 | テンプレート付きMarkdownを作成 | Qiitaテンプレートを先頭に記載したMarkdownファイルを作成。 |
5 | 記事投稿(初回) | コマンドパレットで qiitaに投稿する を実行し、Qiitaに投稿。 |
6 | 記事更新(2回目以降) | テンプレートに ID が追加され、以降は qiitaに投稿する で更新可能。 |
テンプレートの構文は?
以下の2種類あり、メタデータブロックとして記述
タイプ | 開始/終了記号 | 使用例 |
---|---|---|
パターン① | /* ********** */ |
#markdown /**********/ /* ID: */ /* title: タイトル */ /* private: false */ /* istweet: false */ /* tags: aws, qiita */ /**********/ |
パターン② | --- |
#markdown --- ID: title: タイトル private: false istweet: false tags: aws, qiita --- |
テンプレートの各フィールド意味は?
必須項目が3つ、任意項目が2つ
フィールド名 | 必須 | 説明 |
---|---|---|
ID |
×(新規投稿時) ○(更新時) |
Qiita 記事の ID。新規投稿では空欄。更新時は記事IDが必要。初回投稿後、自動で挿入される。 |
title |
○ | 記事タイトル。Qiita上で表示されるタイトル。 |
private |
○ |
true で限定公開、false で全体公開。必ずどちらかを明記。 |
istweet |
× | QiitaとTwitter連携している場合、投稿と同時にツイートするか。true または false 。 |
tags |
○ | 記事に付与するタグ(カンマ区切りで最大5つまで)。例: aws, cloudformation, vscode
|
投稿から更新フローは?
コマンドパレット(Ctrl + Shift + P (F1))で実行
シーン | 使用コマンド | 補足 |
---|---|---|
初回投稿 | qiitaに投稿する |
テンプレートに ID: を空欄で記載。 |
投稿成功後 | 自動で ID: が挿入される |
Qiitaから返されたIDがテンプレートに追加される。 |
更新投稿 | qiitaに投稿する |
初回投稿のマークダウンファイルに記事の ID: が自動挿入。同じMarkdownファイルから上書き可能。タイトルや本文を変更可。 |