1
1
# Qiita CLI、Qiita Preview へようこそ!
2
2
3
- Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。
3
+ Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。
4
4
Qiita CLI を使うことで、普段お使いのエディタなどを使って記事の執筆・投稿がしやすくなります。
5
5
6
6
- よくあるお問い合わせ等を記載しております→[ FAQ] ( #FAQ )
@@ -10,7 +10,7 @@ Qiita CLI を使うことで、普段お使いのエディタなどを使って
10
10
11
11
Qiita CLI、Qiita Preview を利用されたら、[ 利用規約] ( https://qiita.com/terms ) 、[ プライバシーポリシー] ( https://qiita.com/privacy ) に同意したものとみなします。
12
12
13
- [ コミュニティガイドライン] ( https://help.qiita.com/ja/articles/qiita-community-guideline ) をご確認ください。
13
+ [ コミュニティガイドライン] ( https://help.qiita.com/ja/articles/qiita-community-guideline ) をご確認ください。
14
14
みんながより良い体験をするためのマナーについて書かれています。
15
15
16
16
また、記事を書く上で意識すると望ましいもの、気をつけるべき点を[ 良い記事を書くためのガイドライン] ( https://help.qiita.com/ja/articles/qiita-article-guideline ) にまとめています。
@@ -21,7 +21,8 @@ Qiita の Markdown 記法については[Markdown 記法 チートシート](htt
21
21
22
22
### 1. 事前準備
23
23
24
- Qiita CLI を使うには ` Node.js 18.0.0 ` 以上が必要です。Node.js をはじめて使う場合はインストールする必要があります。
24
+ Qiita CLI を使うには ` Node.js 18.0.0 ` 以上が必要です。
25
+ Node.js をはじめて使う場合はインストールする必要があります。
25
26
26
27
### 2. Qiita CLI をインストールする
27
28
@@ -89,19 +90,19 @@ Hi ユーザー名!
89
90
90
91
## Qiita Preview の起動(プレビュー画面の表示)
91
92
92
- 本文の執筆は、ブラウザでプレビューしながら確認できます。ブラウザでプレビューするためには以下のコマンドを実行します。
93
- コマンド実行時に、Qiita に投稿している記事がダウンロードされます。
93
+ 本文の執筆は、ブラウザでプレビューしながら確認できます。
94
+ ブラウザでプレビューするためには以下のコマンドを実行します。 コマンド実行時に、Qiita に投稿している記事がダウンロードされます。
94
95
95
96
``` console
96
97
npx qiita preview
97
98
```
98
99
99
- コマンド実行すると、Qiita Preview(プレビュー画面)にアクセスすることが可能になります。
100
+ コマンド実行すると、Qiita Preview(プレビュー画面)にアクセスすることが可能になります。
100
101
プレビュー画面のデフォルトの URL は http://localhost:8888 です。
101
102
102
103
### 記事ファイルの配置について
103
104
104
- 1 つの記事の内容は、1 つの markdown ファイル(◯◯.md)で管理します。
105
+ 1 つの記事の内容は、1 つの markdown ファイル(◯◯.md)で管理します。
105
106
記事ファイルは` public ` ディレクトリ内に含める必要があります。
106
107
107
108
``` console
@@ -144,7 +145,7 @@ ignorePublish: false # true: `publish`コマンドにおいて無視されます
144
145
# new article body
145
146
```
146
147
147
- ファイルの上部には` --- ` に挟まれる形で記事の設定(Front Matter)が含まれています。
148
+ ファイルの上部には` --- ` に挟まれる形で記事の設定(Front Matter)が含まれています。
148
149
ここに記事のタイトル(title)やタグ(tags)などを yaml 形式で指定します。
149
150
150
151
### 記事の投稿・更新
@@ -171,7 +172,7 @@ npx qiita publish 記事ファイルのベース名 -f
171
172
172
173
### 記事の削除
173
174
174
- Qiita CLI、Qiita Preview から記事の削除はできません。
175
+ Qiita CLI、Qiita Preview から記事の削除はできません。
175
176
` public ` ディレクトリから markdown ファイルを削除しても Qiita 上では削除はされません。
176
177
177
178
[ Qiita] ( https://qiita.com ) 上で記事の削除を行なえます。
@@ -186,7 +187,7 @@ Qiita CLI、Qiita Preview から記事の削除はできません。
186
187
1 . https://github.com/[ユーザー名 ] /[ リポジトリ名] /settings/secrets/actions から、シークレットに` QIITA_TOKEN ` という名前で発行した Qiita のトークンを保存します。
187
188
1 . qiita init を実行したディレクトリ全体を作成したリポジトリにプッシュします。
188
189
189
- デフォルトは` main ` または` master ` ブランチにコミットがあった場合、自動で Qiita へ記事の投稿・更新がされます。
190
+ デフォルトは` main ` または` master ` ブランチにコミットがあった場合、自動で Qiita へ記事の投稿・更新がされます。
190
191
処理の実行の条件は` .github/workflows/publish.yml ` から変更することが可能です。
191
192
192
193
## Qiita CLI のコマンド、オプションについて
@@ -201,7 +202,7 @@ npx qiita help
201
202
202
203
### pull
203
204
204
- 記事ファイルを Qiita と同期します。
205
+ 記事ファイルを Qiita と同期します。
205
206
Qiita 上で更新を行い、手元で変更を行っていない記事ファイルのみ同期されます。
206
207
207
208
``` console
@@ -226,8 +227,8 @@ npx qiita version
226
227
227
228
## ユーザー設定ファイルについて
228
229
229
- ` npx qiita init ` コマンドで生成される` qiita.config.json ` について説明します。
230
- このファイルを用いて、Qiita CLI の設定を行うことができます。
230
+ ` npx qiita init ` コマンドで生成される` qiita.config.json ` について説明します。
231
+ このファイルを用いて、Qiita CLI の設定を行うことができます。
231
232
設定できるオプションは以下の通りです。
232
233
233
234
- includePrivate: qiita.com からダウンロードして保存する記事に限定共有記事を含めるかどうかを選べます。デフォルトは` false ` です。
@@ -261,7 +262,7 @@ npx qiita preview --config ./my_conf/
261
262
262
263
### --root \< root_dir>
263
264
264
- 記事ファイルがダウンロードされるディレクトリを指定できます。
265
+ 記事ファイルがダウンロードされるディレクトリを指定できます。
265
266
デフォルトでは、カレントディレクトリになります。
266
267
267
268
例)
0 commit comments