Qiita-cliを使って記事を書いてみた

はじめに

Qiita-cliを使って記事を書いてみた。これまでの投稿は、Markdown形式の記事をvimで別途作成し、これをqiitaの記事編集エリアにコピペして投稿していた。この手順だと、ブラウザ上での作業がどうしても必要で正直手間だった。コマンドライン上で記事の編集・投稿作業を完結できれば、もっと気軽に(自分のメモとして)投稿できるのに、と思っていた自分としては、Qiita-cliは理想の環境ではないか、と感じたので早速試してみた。

(この記事はQiita-cliがリリースされた直後あたりにメモ書きしたものが投稿されずに放置されていたもの。久々に記事を書く際に参考になったので、備忘録として投稿)

qiita-cli環境の導入方法

基本は以下のリンクのREADMEに書いてある通り行えばよい
https://github.com/increments/qiita-cli

記事の作成方法

まず記事の雛形を生成し、それを起点に記事を書く方法

以下のコマンドにより、カレントディレクトリにpublicというフォルダが生成され、その下にnewArticle.mdというファイルが生成される。newArticleというファイル名は任意。ファイル拡張子(md)は自動的に付加されるので自分ではつける必要がないことに注意

macos$ npx qiita new newArticle
created: newArticle.md

catで生成されたファイルを表示すると、中身は以下のようにyaml形式のヘッダのみで、ヘッダの下に記事をMarkdownk形式で書いていけばよい。titleとtagsは適宜追加・編集する。titleにはファイル名が書かれていることに注意のこと。titleとtagsの記入時、キーワードに半角スペースが含まれている場合はシングルコーテーションでくくること

macos$ cat public/newArticle.md
---
title: newArticle
tags:
  - ''
private: false
updated_at: ''
id: null
organization_url_name: null
slide: false
---
# new article body

id、update_at、等は投稿処理(publish)を行うと自動的に追記される。『# new article body』の行を削除し、Markdown形式で記事を追記する

過去の記事(Markdown形式)を流用して記事を書く方法

こちらのやり方では、yaml形式のヘッダ部分が文書に含まれていないため、ヘッダ部分を手動で追加する必要がある。まずは、newコマンドで雛形ファイルを生成し、その中に過去のファイルを読み込んで編集すれば楽。なおtitleとtagsは投稿する記事に合わせて適宜編集が必要になる

preview機能で投稿前に記事の確認ができるのが便利

編集するターミナルとは別のターミナルから以下のコマンドでpreviewを起動しておく

macos$ npx qiita preview

ブラウザから以下にアクセスすると、qiitaと同じ見た目で投稿前の記事を確認することができる
http://localhost:8888

投稿方法

コマンドラインで行う場合

以下のコマンドで記事を投稿する。xのところはハッシュコード(?)が表示され、このコードがヘッダのidのところに追記される

macos$ npx qiita publish newArticle
Posted: newArticle -> xxxxxxxxxxxxxxxxxx 
Successful!

preview画面から行う場合

画面右上にある"記事を投稿する"ボタンをクリックする。投稿が成功すれば、 preview画面の上部に"投稿が成功しました"と表示が出る。

最後に

これで備忘録として記事を投稿する頻度が上がること間違いなし(結局はネタ次第なのですが)