この記事は何
昨日Qiita CLIをベータ版として公開しました！
Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。 Qiita CLIを使うことで、エディタなどを使って記事の執筆・投稿がしやすくなります。
この記事は、Qiita CLIを使ってQiitaの記事執筆をするときに便利なTipsを紹介します。
Copilotを用いて記事を執筆する
Qiita CLIを用いれば、記事の執筆をエディタで行うことができます。また、記事のデータはMarkdown形式で保存されるため、エディタの機能やプラグイン、ライブラリなどを用いて記事の執筆を行うことができます。
Markdownの執筆にも、Copilotは便利に活用できます。
実は、この文章もCopilotを用いて執筆しています。
なお、Copilot.vimでMarkdownの補完を行えるようにするTipsも以前Qiitaに投稿しています。
markdownlintを用いて記事のLint・フォーマットを行う
Qiita CLIを用いると、編集した記事ファイルは一括でQiitaに投稿・更新することができます。そのため、markdownlintなどでファイルのフォーマットをかけても、一括で記事の更新を行うことが可能です。
一括で変更した記事の反映を行う場合はqiita publish --allというコマンドか、GitHub Actionsの設定をすることで実現できます。
具体的な利用方法はREADMEの以下の部分にまとまっています。
markdownlintを導入して記事ファイルを修正する方法は、以下の記事が参考になります。
GitHub上でレビューを行う
Qiita CLIとgitを用いれば、記事の執筆をGitHub上でレビューすることができます。
また、GitHub Actionsを用いればレビュー完了後、マージをすることでそのままQiitaに反映することも可能です。
GitHub Actionsの設定方法は前項と同じく以下にまとまっています。
最後に
Qiita CLIはまだベータ版です。不具合や使いにくいところもあると思います。
もし、不具合や改善点などあったら、Qiita Discussionsでフィードバックをいただけると嬉しいです！