Skip to content

Commit 48beeb6

Browse files
committed
Add readme with faq
1 parent 987997b commit 48beeb6

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Qiita CLI とは、手元の環境で記事の執筆・プレビュー・投稿ができるツールです。
44
Qiita CLI を使うことで、普段お使いのエディタなどを使って記事の執筆・投稿がしやすくなります。
55

6-
> 不具合やご意見などございましたら[Qiita Discussions](https://github.com/increments/qiita-discussions/discussions)へご投稿ください。
6+
- よくあるお問い合わせ等を記載しております→[FAQ](#FAQ)
7+
- 不具合やご意見などございましたら[Qiita Discussions](https://github.com/increments/qiita-discussions/discussions)へご投稿ください。
78

89
## ご利用の前に
910

@@ -229,7 +230,7 @@ npx qiita version
229230
このファイルを用いて、Qiita CLI の設定を行うことができます。
230231
設定できるオプションは以下の通りです。
231232

232-
- includePrivate: 限定共有記事を含めるかどうかを選べます。デフォルトは`false`です。
233+
- includePrivate: qiita.com からダウンロードして保存する記事に限定共有記事を含めるかどうかを選べます。デフォルトは`false`です。
233234
- host: `qiita preview`コマンドで利用するホストを指定できます。デフォルトは`localhost`です。
234235
- port: `qiita preview`コマンドで利用するポートを指定できます。デフォルトは`8888`です。
235236

@@ -278,3 +279,25 @@ npx qiita publish c732657828b83976db47 --root ./my_articles/
278279
npx qiita login --verbose
279280
npx qiita preview --verbose
280281
```
282+
283+
## FAQ
284+
285+
### 限定共有投稿をする方法がわからない
286+
287+
[ユーザー設定ファイル](#%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E8%A8%AD%E5%AE%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)で下記指定をします。
288+
`includePrivate: true` (デフォルトは`false`です。)
289+
qiita.com からダウンロードして保存する記事に限定共有記事を含めるかどうかを選べます。
290+
291+
[記事ファイル](#%E8%A8%98%E4%BA%8B%E3%81%AE%E4%BD%9C%E6%88%90)で下記指定をします。
292+
`private: true`(private: false # true: 限定共有記事 / false: 公開記事)
293+
294+
### エラーが出て解決しない
295+
296+
現在、エラー内容が適切に表示できていない場合がございます。
297+
298+
エラーを解決できない場合は、こちらのDiscussions も参考にしてみてください🙇
299+
https://github.com/increments/qiita-discussions/discussions/561
300+
301+
## 不具合・ご意見は Discussions へ
302+
303+
不具合・ご意見等ございましたら[Qiita Discussions](https://github.com/increments/qiita-discussions/discussions)へお寄せください。

0 commit comments

Comments
 (0)