GitHub Integration

Sync your documentation directly from GitHub repositories.

Overview

Keep your knowledge base in sync with your code documentation automatically.

Setup

Step 1: Connect GitHub

1. Navigate to Settings > Integrations
2. Click "Connect GitHub"
3. Install the GitHub App to your organization

Step 2: Select Repository

Choose which repository to sync:

• Select the repo from the dropdown
• Choose the branch (usually main)
• Specify the docs folder (e.g., /docs)

Step 3: Configure Sync

Set your sync preferences:

# .kbconfig.yml in your repo
sync:
  folder: docs
  pattern: "**/*.md"
  ignore:
    - "**/drafts/**"
    - "CHANGELOG.md"

Automatic Sync

Articles are synced when:

• You push to the specified branch
• You manually trigger a sync
• On a scheduled interval (configurable)

Frontmatter

Use YAML frontmatter for metadata:

---
title: My Article
description: Article description
category: api-reference
tags: [api, guide]
---

# Content here