Back to Guide
🤖

GitHub Copilot

GitHub's AI pair programmer

Quick Setup

Copy and paste this prompt into Copilot Chat:

Create .github/copilot-instructions.md file with VerseKit integration:

# VerseKit Document Templates
When asked to create styled documents (README, API docs, proposals, reports):
1. Fetch template from https://versekit.io/api/templates/[slug]
2. Use the html_content from response.data
3. Replace all {{variable}} placeholders with actual content
4. Save as .html file

Popular slugs: github-readme, api-documentation, business-proposal, project-status-report
Browse all: https://versekit.io/explore

Copilot will create .github/copilot-instructions.md in your repo

How copilot-instructions.md Works

  • •GitHub Copilot reads .github/copilot-instructions.md
  • •Instructions are included in Copilot Chat context
  • •Works in VS Code, JetBrains, and GitHub.com
  • •Shared across your team via Git

Usage Example

After setup, ask in Copilot Chat:

"Create a business proposal using the business-proposal template"

Copilot will:

  • ✓ Fetch the template from VerseKit API
  • ✓ Ask for necessary details
  • ✓ Generate a professional document
  • ✓ Save as a styled HTML file

Works With

Copilot Chat

VS Code sidebar

Copilot Edits

Multi-file editing

GitHub.com

Web interface

Ready to Start?