概要

よくある質問 (FAQ)

一般的な質問

Q: Docsbookとは何ですか?

A: Docsbookは、あなたのGitHubドキュメントを5秒で美しいサイトに変換します。GitHubリポジトリを接続するだけで完了です!


Q: 始めるのに料金はかかりますか?

A: いいえ!無料プランには、1つのリポジトリ、GitHubとの同期、美しいデザインが含まれます。プレミアム版(1回限り$29)では、カスタムドメイン、翻訳、その他を追加できます。


どのようなリポジトリが必要ですか?

A: Markdownファイルを含む、任意の公開GitHubリポジトリです。これには以下が含まれます:

  • README.md
  • プロジェクトドキュメント
  • 手順
  • APIリファレンス
  • Markdownファイル

Q: プライベートGitHubリポジトリはサポートされていますか?

A: 現在は公開リポジトリのみです。プライベートリポジトリは将来的に予定されています。


Q: GitHubで何かを設定する必要がありますか?

A: いいえ!OAuth経由でアカウントを接続するだけです。Docsbookは公開リポジトリにアクセスします。


Usage

Q: ドキュメントを更新するにはどうすればよいですか?

A: GitHubのファイルを更新するだけです。サイトは自動的に同期されます。

  1. .md ファイルを編集します
  2. GitHubにコミットします
  3. Docsbookサイトを開きます
  4. 更新を確認します!

Q: ドキュメントはどのくらいの速さで更新されますか?

A: 非常に高速です。次回の訪問時:

  1. サイトを訪問します
  2. DocsbookはGitHubで新しいコンテンツをチェックします
  3. 最新バージョンを表示します

通常:即座に。


Q: なぜサイトが更新されないのですか?

A: 確認してください:

  1. コミットは実際にGitHubにありますか? (github.comで確認してください)
  2. ブラウザを更新しましたか? (Ctrl+F5)
  3. 1〜2分経過しましたか?
  4. ファイルの拡張子は .md ですか?

Q: どのようなフォルダ構造を使用すればよいですか?

A: どのようなものでも!推奨:

repo/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api/
│   └── guides/

ただし、他の構造でも問題ありません。


Q: .markdown.md の代わりに使うことはできますか?

A: はい、どちらの拡張子でも動作します。


Q: ファイル間のリンクは機能しますか?

A: はい!使用してください:

[Link](/ja/docs/path/to/file)
[Link to folder](/ja/docs/../folder/file)

これらは適切なURLに自動的に変換されます。


Q: 画像は使用できますか?

A: フォルダ(例:docs/images/)に配置し、次のように参照してください:

![Description](https://raw.githubusercontent.com/docsbook-io/docs/main/./images/screenshot.png)

PNG、JPG、GIF、WebPがサポートされています。


Q: HTMLを使用できますか?

A: MarkdownはHTMLをサポートするので、はい:

<div>Regular HTML</div>

ただし、プレーンなMarkdownを使用することをお勧めします。


アクセス & セキュリティ

Q: 誰が私のドキュメントを見ることができますか?

A: インターネット上の誰でも!あなたのサイトは完全に公開されています。

  • GitHubアカウントを持っていない人
  • 検索エンジンのボット (Google, Bing)
  • 誰でも

これは想定されることです — あなたは誰もがあなたのドキュメントを見られるようにしたいと思っています。


Q: これはプライベートなGitHubリポジトリとどのように関係がありますか?

A: GitHubリポジトリがプライベートであっても、Docsbook上のドキュメントは公開されています。それが魔法です! 😊

(プライベートリポジトリはまだサポートされていません)


Q: 私のドキュメントは安全ですか?

A: はい、HTTPS (SSL) と Vercel CDN が使用されています。


Q: 誰かがDocsbookを通じて私のドキュメントを編集できますか?

A: いいえ、それは不可能です。編集はGitHubでのみ可能です。


Q: 誰がFloat Widget (コントロールボタン) を見ることができますか?

A: ログインしているあなただけです。他の人はドキュメントだけを見ます。


プレミアム

Q: プレミアムとは何ですか?

A: 追加機能付きの一時購読プラン($29)。

  • 無制限のリポジトリ
  • カスタムドメイン
  • 「Powered by Docsbook」の非表示
  • 自動翻訳

Q: プレミアムの費用はいくらですか?

A: $29 USD 一時払い、生涯にわたってご利用いただけます。最初の100人の顧客は$19でした。


Q: どのように支払いますか?

A: Float Widget の「Premium へのアップグレード」をクリック → Stripe フォームにカード情報を入力します。

利用可能: Visa、Mastercard、AmEx、Apple Pay、Google Pay。


Q: 支払いは安全ですか?

A: はい、100% 安全です。支払いは Stripe (世界的なリーダー) によって処理されます。Docsbook はカード番号を見ることができません。


Q: 返金は可能ですか?

A: はい、最初の30日以内であれば全額返金いたします。 support@docsbook.io までお問い合わせください。


Q: 価格は上がりますか?

A: いいえ、$29 が恒久的な価格です。一度支払えば、その後は料金は発生しません。


Q: 複数のワークスペースで Premium を購入できますか?

A: はい、購入はそれぞれ個別に必要です。手頃な価格です ($29/ワークスペース)。


Q: 組織向けの割引はありますか?

A: 特別な手配については、support@docsbook.io までお問い合わせください。


ドメイン

Q: 自分のドメインをどのように使用しますか?

A: プレミアム機能です。ガイド: カスタムドメイン設定

TL;DR:

  1. 設定でドメインを入力
  2. DNSを更新 (CNAMEを追加)
  3. 30分待つ
  4. 完了!

Q: ルートドメインとサブドメインのどちらが良いですか?

A: サブドメインをお勧めします:

✅ docs.example.com (recommended)
✅ example.com (also works)
✅ guide.example.com (multiple can be used)

Q: SSL (HTTPS) は必要ですか?

A: Docsbook は Let's Encrypt を通じて自動的に設定します。無料であり、お客様のアクションは不要です。


Q: DNS 伝播にはどのくらい時間がかかりますか?

A: 通常 15 ~ 30 分、最大 48 時間です。


翻訳

Q: ドキュメントを翻訳するにはどうすればよいですか?

A: プレミアム機能です。ガイド: 翻訳

TL;DR:

  1. 設定を開く
  2. 言語を選択する
  3. 保存をクリックする
  4. Docsbook は数分で翻訳します

Q: どの言語がサポートされていますか?

A: 100 以上、以下を含む:

  • スペイン語、フランス語、ドイツ語
  • ロシア語、中国語、日本語
  • アラビア語、韓国語、タイ語
  • その他多数

Q: AI 翻訳の品質はどのくらいですか?

A: 技術ドキュメントには適しています。ただし、慣用句や文化的背景については編集が必要になる場合があります。


Q: ドキュメントを更新した場合、翻訳は更新されますか?

A: はい、自動的に更新されます。


Q: 翻訳を編集できますか?

A: はい、ダウンロードして手動で編集できます。 support@docsbook.io までお問い合わせください。


サポート & 問題

Q: サポートに連絡するにはどうすればよいですか?

A: メール: support@docsbook.io

プレミアム顧客は優先されます。


Q: Docsbook のドキュメントはありますか?

A: はい、これを読んでいるからです!他のセクションをご覧ください。


Q: 何か壊れている場合はどうすればよいですか?

A: 問題の説明を添えて support@docsbook.io までご連絡ください。


Q: ステータスページはありますか?

A: 近日中に公開予定です。 twitter.com/docsbook でフォローしてください。


技術的な質問

Q: Docsbookは何で構築されていますか?

A: Next.js, React, Vercel, Stripe, GitHub API。


Q: データはどこに保存されていますか?

A: Vercel (米国およびその他の国のサーバー) と Neon Postgres。


Q: どのMarkdownパーサーが使用されていますか?

A: Remark + Rehype。GitHub Flavored Markdown (GFM) がサポートされています。


Q: サイト検索は機能しますか?

A: 組み込み検索は近日公開予定です。現時点ではブラウザ検索 (Ctrl+F) を使用してください。


Q: ダークテーマはありますか?

A: 近日公開予定です。現在、ライトテーマのみが利用可能です。


Q: 同時に何人の訪問者を処理できますか?

A: Vercelは自動的にスケールします。負荷は気にしないでください。


Q: 利用規約はありますか?

A: はい、利用規約 (近日公開) をご確認ください。


Q: プライバシーポリシーはどうなっていますか?

A: はい、プライバシーポリシー (近日公開) をご確認ください。


Q: 規約に違反した場合、どうなりますか?

A: こちらからご連絡します。通常は、修正する機会を与えます。


質問への回答が見つからない場合

support@docsbook.io までご連絡ください — 喜んでお手伝いします! 😊


次へ: