11# Qiita CLI、Qiita Preview へようこそ!
22
3- Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。
3+ Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。
44Qiita CLI を使うことで、普段お使いのエディタなどを使って記事の執筆・投稿がしやすくなります。
55
66- よくあるお問い合わせ等を記載しております→[ FAQ] ( #FAQ )
@@ -10,7 +10,7 @@ Qiita CLI を使うことで、普段お使いのエディタなどを使って
1010
1111Qiita CLI、Qiita Preview を利用されたら、[ 利用規約] ( https://qiita.com/terms ) 、[ プライバシーポリシー] ( https://qiita.com/privacy ) に同意したものとみなします。
1212
13- [ コミュニティガイドライン] ( https://help.qiita.com/ja/articles/qiita-community-guideline ) をご確認ください。
13+ [ コミュニティガイドライン] ( https://help.qiita.com/ja/articles/qiita-community-guideline ) をご確認ください。
1414みんながより良い体験をするためのマナーについて書かれています。
1515
1616また、記事を書く上で意識すると望ましいもの、気をつけるべき点を[ 良い記事を書くためのガイドライン] ( https://help.qiita.com/ja/articles/qiita-article-guideline ) にまとめています。
@@ -21,7 +21,8 @@ Qiita の Markdown 記法については[Markdown 記法 チートシート](htt
2121
2222### 1. 事前準備
2323
24- Qiita CLI を使うには ` Node.js 18.0.0 ` 以上が必要です。Node.js をはじめて使う場合はインストールする必要があります。
24+ Qiita CLI を使うには ` Node.js 18.0.0 ` 以上が必要です。
25+ Node.js をはじめて使う場合はインストールする必要があります。
2526
2627### 2. Qiita CLI をインストールする
2728
@@ -89,19 +90,19 @@ Hi ユーザー名!
8990
9091## Qiita Preview の起動(プレビュー画面の表示)
9192
92- 本文の執筆は、ブラウザでプレビューしながら確認できます。ブラウザでプレビューするためには以下のコマンドを実行します。
93- コマンド実行時に、Qiita に投稿している記事がダウンロードされます。
93+ 本文の執筆は、ブラウザでプレビューしながら確認できます。
94+ ブラウザでプレビューするためには以下のコマンドを実行します。 コマンド実行時に、Qiita に投稿している記事がダウンロードされます。
9495
9596``` console
9697npx qiita preview
9798```
9899
99- コマンド実行すると、Qiita Preview(プレビュー画面)にアクセスすることが可能になります。
100+ コマンド実行すると、Qiita Preview(プレビュー画面)にアクセスすることが可能になります。
100101プレビュー画面のデフォルトの URL は http://localhost:8888 です。
101102
102103### 記事ファイルの配置について
103104
104- 1 つの記事の内容は、1 つの markdown ファイル(◯◯.md)で管理します。
105+ 1 つの記事の内容は、1 つの markdown ファイル(◯◯.md)で管理します。
105106記事ファイルは` public ` ディレクトリ内に含める必要があります。
106107
107108``` console
@@ -144,7 +145,7 @@ ignorePublish: false # true: `publish`コマンドにおいて無視されます
144145# new article body
145146```
146147
147- ファイルの上部には` --- ` に挟まれる形で記事の設定(Front Matter)が含まれています。
148+ ファイルの上部には` --- ` に挟まれる形で記事の設定(Front Matter)が含まれています。
148149ここに記事のタイトル(title)やタグ(tags)などを yaml 形式で指定します。
149150
150151### 記事の投稿・更新
@@ -171,7 +172,7 @@ npx qiita publish 記事ファイルのベース名 -f
171172
172173### 記事の削除
173174
174- Qiita CLI、Qiita Preview から記事の削除はできません。
175+ Qiita CLI、Qiita Preview から記事の削除はできません。
175176` public ` ディレクトリから markdown ファイルを削除しても Qiita 上では削除はされません。
176177
177178[ Qiita] ( https://qiita.com ) 上で記事の削除を行なえます。
@@ -186,7 +187,7 @@ Qiita CLI、Qiita Preview から記事の削除はできません。
1861871 . https://github.com/[ユーザー名 ] /[ リポジトリ名] /settings/secrets/actions から、シークレットに` QIITA_TOKEN ` という名前で発行した Qiita のトークンを保存します。
1871881 . qiita init を実行したディレクトリ全体を作成したリポジトリにプッシュします。
188189
189- デフォルトは` main ` または` master ` ブランチにコミットがあった場合、自動で Qiita へ記事の投稿・更新がされます。
190+ デフォルトは` main ` または` master ` ブランチにコミットがあった場合、自動で Qiita へ記事の投稿・更新がされます。
190191処理の実行の条件は` .github/workflows/publish.yml ` から変更することが可能です。
191192
192193## Qiita CLI のコマンド、オプションについて
@@ -201,7 +202,7 @@ npx qiita help
201202
202203### pull
203204
204- 記事ファイルを Qiita と同期します。
205+ 記事ファイルを Qiita と同期します。
205206Qiita 上で更新を行い、手元で変更を行っていない記事ファイルのみ同期されます。
206207
207208``` console
@@ -226,8 +227,8 @@ npx qiita version
226227
227228## ユーザー設定ファイルについて
228229
229- ` npx qiita init ` コマンドで生成される` qiita.config.json ` について説明します。
230- このファイルを用いて、Qiita CLI の設定を行うことができます。
230+ ` npx qiita init ` コマンドで生成される` qiita.config.json ` について説明します。
231+ このファイルを用いて、Qiita CLI の設定を行うことができます。
231232設定できるオプションは以下の通りです。
232233
233234- includePrivate: qiita.com からダウンロードして保存する記事に限定共有記事を含めるかどうかを選べます。デフォルトは` false ` です。
@@ -261,7 +262,7 @@ npx qiita preview --config ./my_conf/
261262
262263### --root \< root_dir>
263264
264- 記事ファイルがダウンロードされるディレクトリを指定できます。
265+ 記事ファイルがダウンロードされるディレクトリを指定できます。
265266デフォルトでは、カレントディレクトリになります。
266267
267268例)
0 commit comments