Answer IO ユーザーマニュアル

Appearance

Answer IO ユーザーマニュアル ​

Answer IOのユーザーマニュアルサイトです。VitePressを使用して構築されています。

概要 ​

このプロジェクトは、Answer IO（株式会社フィードフォース）のユーザー向けドキュメントサイトです。

Answer IOは、AI検索でのブランドスコアを見える化するプラットフォームです。

技術スタック ​

  • フレームワーク: VitePress v1.3.4
  • 言語: TypeScript
  • スタイリング: カスタムCSS + VitePressデフォルトテーマ
  • ホスティング: GitHub Pages
  • ドメイン: docs.answer-io.jp

ローカル開発 ​

前提条件 ​

  • Node.js 20.x以上
  • npm 10.x以上

セットアップ ​

bash
# user-manualディレクトリに移動
cd user-manual

# 依存関係をインストール
npm install

開発サーバーの起動 ​

bash
# 開発サーバーを起動（ホットリロード有効）
npm run docs:dev

ブラウザで http://localhost:5173 を開くと、ドキュメントサイトが表示されます。

ビルド ​

bash
# 本番用にビルド
npm run docs:build

# ビルド結果をプレビュー
npm run docs:preview

ビルド結果は .vitepress/dist/ ディレクトリに出力されます。

ディレクトリ構造 ​

user-manual/
├── .vitepress/
│   ├── config.ts       # VitePress設定
│   ├── theme/          # カスタムテーマ
│   │   ├── index.ts
│   │   └── style.css
│   └── public/         # 静的ファイル
├── ja/                 # 日本語コンテンツ
│   ├── index.md        # トップページ
│   ├── guide/          # ユーザーガイド
│   │   ├── getting-started.md
│   │   ├── dashboard.md
│   │   ├── brands.md
│   │   ├── queries.md
│   │   └── reports.md
│   ├── features/       # 機能説明
│   │   ├── ai-analysis.md
│   │   ├── multi-platform.md
│   │   └── reporting.md
│   ├── troubleshooting/ # トラブルシューティング
│   │   ├── common-issues.md
│   │   ├── api-errors.md
│   │   └── performance.md
│   ├── faq.md          # よくある質問
│   └── api/            # API仕様
│       └── index.md
├── package.json        # 依存関係管理
└── README.md           # このファイル

コンテンツの編集 ​

新しいページの追加 ​

  1. 適切なディレクトリに新しい .md ファイルを作成
  2. .vitepress/config.ts のサイドバー設定に追加

例：

typescript
sidebar: {
  '/ja/guide/': [
    {
      text: 'はじめに',
      items: [
        { text: 'クイックスタート', link: '/ja/guide/getting-started' },
        { text: '新しいページ', link: '/ja/guide/new-page' },  // 追加
      ]
    }
  ]
}

Markdownの記法 ​

VitePressは、以下のMarkdown拡張をサポートしています：

  • Frontmatter: ページメタデータ
  • カスタムコンテナ: ::: tip, ::: warning, ::: danger
  • コードブロック: シンタックスハイライト
  • 内部リンク: 相対パスでリンク

詳しくはVitePressドキュメントをご覧ください。

デプロイメント ​

GitHub Actionsによる自動デプロイ ​

user-manual/ ディレクトリの変更がmainブランチにプッシュされると、GitHub Actionsが自動的にビルドとデプロイを行います。

ワークフローファイル: .github/workflows/docs-deploy.yml

DNS設定 ​

docs.answer-io.jp サブドメインをGitHub Pagesに向けるようにDNS設定が必要です：

  1. DNSプロバイダーでCNAMEレコードを追加：

    • Name: docs
    • Value: {your-username}.github.io
    • TTL: 3600

  2. GitHub PagesでカスタムドメインとSSLを設定

貢献 ​

ドキュメントの改善にご協力いただける方は、以下の手順でプルリクエストを送信してください：

  1. このリポジトリをフォーク
  2. 新しいブランチを作成 (git checkout -b feature/improve-docs)
  3. 変更をコミット (git commit -am 'Add new documentation')
  4. ブランチにプッシュ (git push origin feature/improve-docs)
  5. プルリクエストを作成

ライセンス ​

MIT License

サポート ​

ご不明な点がございましたら、以下までお問い合わせください：

最終更新: 2025年1月 開発: 株式会社フィードフォース

最終更新:

Answer IO - AI検索でのブランドスコアを見える化

Copyright © 2025 株式会社フィードフォース