GitPage Documentation
Everything you need to know about creating and editing websites with GitPage
Overview
GitPage transforms how you create websites and landing pages. Using AI and automation, GitPage generates professionally designed, hosted websites in minutes—no coding required.
How It Works
Provide Your Requirements
Enter your website requirements through our simple web interface or use our API for programmatic access. Describe your vision, and GitPage handles the rest.
AI Generates Your Website
Our AI (via OpenRouter - accessing Claude, GPT-4, or other models) processes your requirements and creates a custom-designed webpage using modern web technologies, responsive design, and best practices.
Automatic Deployment
The generated page is automatically deployed to GitLab Pages (recommended) or GitHub Pages, providing immediate FREE hosting with a live URL.
Ready to Share
Within minutes, you have a professional, responsive website ready to use, customize, or share with clients.
Add Custom Domain
Optionally connect your own domain name for a professional branded web address instead of using the default GitHub or GitLab Pages URL.
Required Setup
To use GitPage, you need to configure two API keys. This is a one-time setup that takes about 10 minutes:
Recommended Setup: GitLab + OpenRouter
For the best experience, we recommend using GitLab for hosting and OpenRouter for AI. This combination offers:
1. GitLab Account & Token
Provides version control and free hosting for your generated landing pages through GitLab Pages. No restrictions on commercial sites!
Required for deployment and hosting
2. OpenRouter API Key
Powers the intelligent conversion of your requirements into professionally designed web pages. One API key gives you access to all AI models!
- • Claude (Anthropic) - Best for creative content
- • GPT-4 (OpenAI) - Great all-rounder
- • Gemini (Google) - Fast and efficient
- • 100+ other models - All accessible through one key
3. Web3Forms Access Key (Optional)
Enables contact forms on your landing pages. Get a free key at web3forms.com
Optional - for functional contact forms
4. GitPage API Key
Enables programmatic access to create websites via API (optional, only if using API integration).
Optional - for API access only
GitHub + Direct API (Deprecated Dec 31, 2025)
You can also use GitHub for hosting and direct API keys from individual providers (Anthropic, OpenAI, Google). However, this setup method is being deprecated:
⚠️ Deprecation Notice: Direct API method will be deprecated from December 31st, 2025. We recommend migrating to OpenRouter before this date. GitHub hosting remains supported.
💡 Important Note
Typeform integration is being deprecated. We now recommend using our web interface or API for submitting website requirements. Typeform webhooks are still supported for existing users but will be phased out in future updates.
Detailed Setup Instructions
Step 1: Git Provider Setup
Option A: GitLab
Why GitLab? GitLab Pages has no restrictions on commercial sites, making it ideal for e-commerce, SaaS, or business websites. Plus, you get free CI/CD pipelines included!
- 1.Log in to GitLab.com (create a free account if needed)
- 2.Click your avatar → Edit Profile → Access Tokens (in left sidebar)
- 3.Click 'Add new token'
- 4.Set the token name (e.g., "GitPage Access")Select these scopes:
- ✓ api (Full API access)
- ✓ read_repository (Read repository contents)
- ✓ write_repository (Write to repository)
Set expiration: Choose "No expiration" or your preferred date - 5.Click 'Create personal access token' and copy it immediately (you won't see it again!)
- 6.In GitPage, go to 'Manage Keys', select "GitLab" as your provider, and paste your token
Option B: GitHub
Note: GitHub Pages has restrictions on commercial sites. Use GitLab if you're building e-commerce or business websites.
- 1.Log in to GitHub.com (create a free account if needed)
- 2.Go to Settings → Developer Settings → Personal Access Tokens
- 3.Select 'Tokens (classic)' and click 'Generate New Token'
- 4.Set the token name (e.g., "GitPage Access")Select these permissions:
- ✓ repo (Full control of private repositories)
- ✓ workflow (Update GitHub Action workflows)
- 5.Click 'Generate Token' and copy it immediately (you won't see it again!)
- 6.In GitPage, go to 'Manage Keys' and paste your token in the GitHub Access Token field
💡 Tip: You can add tokens for both GitHub and GitLab. Switch between them anytime in 'Manage Keys' - new sites will use your selected provider.
Step 2: OpenRouter API Key Setup
Why OpenRouter? OpenRouter provides a unified API to access multiple AI models (Claude, GPT-4, Gemini, etc.) with a single API key. It's cost-effective and gives you flexibility to switch between models without managing multiple API keys.
✨ Best Part: When you use OpenRouter, you don't need to set up any other LLM API keys (Anthropic, OpenAI, Gemini, etc.). OpenRouter handles all model access through one unified interface—making it the simplest setup option. Once configured, you're all done!
- 1.Visit openrouter.ai and create a free account
- 2.Sign in and navigate to the API Keys section
- 3.Click 'Create Key' and give it a name (e.g., "GitPage Integration")
- 4.Copy the generated API key (starts with "sk-or-...")
- 5.Add credits to your OpenRouter account (as low as $5 to get started)
- 6.In GitPage, go to 'Manage Keys', select "OpenRouter" as your API method, and paste the key
✨ OpenRouter Benefits
🔒 Keep this key secure and never share it publicly
Alternative: Direct API Keys
The following direct API setup methods are being deprecated from December 31st, 2025. We strongly recommend using OpenRouter instead for simpler setup and better experience.
If you still want to use direct APIs, expand the sections below:
Alternative: Anthropic API Key (Direct - Deprecated)
⚠️ Deprecation Notice: Direct API method will be deprecated from December 31st, 2025. Please use OpenRouter instead.
- 1.Visit anthropic.com and create an account
- 2.Navigate to API Settings in your dashboard
- 3.Click 'Create API Key' and give it a name (e.g., "GitPage Integration")
- 4.Copy the generated API key
- 5.Add credits to your Anthropic account (minimum $5 recommended)
- 6.In GitPage, paste the key in the Anthropic API field in 'Manage Keys'
⚠️ Important: Anthropic API Tier System
Anthropic uses a tier-based rate limit system. Free tier (Tier 1) users may experience issues when generating or editing large landing pages.
Why this matters: Large HTML files can generate 15,000-20,000 output tokens, exceeding the free tier limit.
Recommended: Add $5 in credits to reach Tier 2 for reliable operation.
If you hit rate limits, the system will automatically retry after a delay with reduced token usage. Check your tier at console.anthropic.com
🔒 Keep this key secure and never share it publicly
Alternative: Google Gemini API Key (Direct - Deprecated)
⚠️ Deprecation Notice: Direct API method will be deprecated from December 31st, 2025. Please use OpenRouter instead.
- 1.Visit Google AI Studio and sign in with your Google account
- 2.Click 'Get API Key' and create a new API key
- 3.Copy the generated API key
- 4.In GitPage, paste the key in the Gemini API field in 'Manage Keys'
⚠️ Critical: Billing Account Required
Your Gemini API key will not work without a billing account. Even if you generate an API key from Google AI Studio, API calls will fail unless you have:
To set up billing:
- 1. Visit Google Cloud Billing
- 2. Create a billing account and add payment information
- 3. Link the billing account to your Google Cloud project
- 4. Enable the Generative Language API in your project
Without billing enabled, you'll receive authentication or quota errors even with a valid API key. Learn more at Google Gemini Billing Documentation
🔒 Keep this key secure and never share it publicly
Alternative: OpenAI API Key (Direct - Deprecated)
⚠️ Deprecation Notice: Direct API method will be deprecated from December 31st, 2025. Please use OpenRouter instead.
- 1.Visit OpenAI Platform and create an account
- 2.Navigate to API Keys section in your account settings
- 3.Click 'Create new secret key' and give it a name (e.g., "GitPage Integration")
- 4.Copy the generated API key immediately (you won't be able to see it again)
- 5.Add credits to your OpenAI account or set up billing
- 6.In GitPage, paste the key in the OpenAI API field in 'Manage Keys'
💡 OpenAI API Usage
GitPage uses OpenAI's latest models for content generation. Make sure you have:
Monitor your usage and costs at OpenAI Usage Dashboard
🔒 Keep this key secure and never share it publicly
Step 3: GitPage API Key (Optional)
Only needed if you want to use our API for programmatic website generation.
- 1.Sign in to your GitPage account
- 2.Go to your Dashboard
- 3.Scroll to the "API Access" section
- 4.Click "Generate API Key" and copy it securely
Hosting Options & Restrictions
✨ Recommended: GitLab Pages (No Restrictions)
GitLab Pages has no restrictions on commercial websites. You can freely build e-commerce sites, SaaS platforms, business websites, and any commercial project without worrying about terms of service violations.
⚠️ Alternative: GitHub Pages Usage Restrictions
If you choose GitHub Pages for hosting, be aware of specific usage restrictions:
✓ Allowed Uses
- • Portfolio websites
- • Personal blogs
- • Project documentation
- • Informational websites
- • Open source project sites
- • Educational content
✗ Prohibited Uses
- • E-commerce sites with payments
- • Commercial SaaS platforms
- • Online business operations
- • Sensitive transactions (passwords, credit cards)
- • Sites primarily for commercial transactions
Source: GitHub Pages Terms of Service
💡 Need Commercial Hosting?
Good news! You own the complete source code generated by GitPage. If you need to build a commercial or e-commerce website, you can easily deploy your GitHub repository to commercial hosting platforms:
These platforms offer direct GitHub integration, making deployment as simple as connecting your repository. This gives you the flexibility to use GitHub Pages for personal projects while migrating commercial sites to appropriate hosting.
Quick Start Guide
Recommended Setup: GitLab + OpenRouter
Follow these steps for the simplest and most reliable setup experience.
- 1.Create a GitLab account and generate an access token (Step 1 above)
- 2.Create an OpenRouter account and get your API key (Step 2 above)
- 3.Sign in to your GitPage account
- 4.Go to 'Manage Keys' and enter your GitLab token and OpenRouter API key
- 5.Go to the main page and enter your website requirements in the text area
- 6.Click submit and wait 1-3 minutes for your website to be generated
- 7.View your new website in 'My Sites' and get your live URL
Troubleshooting
Common Issues
Website not generating?
- →Verify GitLab/GitHub token is correctly entered in Manage Keys
- →Confirm OpenRouter API key is valid and has credits
- →Check that GitLab token has 'api', 'read_repository', and 'write_repository' scopes
- →Allow up to 3 minutes for site generation
API keys expired or invalid?
- →Regenerate your GitLab/GitHub token and update in Manage Keys
- →Check OpenRouter account balance and add more credits if needed
- →Ensure no extra spaces when copying/pasting API keys
Website deployed but links broken?
- →Check GitLab/GitHub Pages is enabled for your repository
- →Wait a few minutes for GitLab/GitHub Pages deployment to complete
- →See Navigation Link Fix Guide below for policy/terms pages
Still having issues?
Contact our support team using the chat widget. We typically respond within a few hours during business days.
Editing Your Website
GitPage now includes a powerful visual editor that allows you to customize your website without touching code. Here's how to use it:
1. Access the Editor
- →Go to 'My Sites' from your dashboard
- →Find the website you want to edit
- →Click the 'Edit' button next to your site
- →The edit modal will open with all customization options
2. What You Can Edit
Content
- • Page heading and hero statement
- • Features and benefits
- • Contact email and CTA link
- • FAQ section content
Design
- • Color palette (Vibrant, Calm, Dark, Warm)
- • Typography style (Modern, Classic, Bold, Minimal)
- • Layout structure (Spacious, Compact, Grid, Asymmetric)
- • Component style (Rounded, Sharp, Glass, Neumorphic)
- • Button styling and animations
- • Icon library selection
Settings
- • Page style (Informational, Creative, Minimal)
- • Color scheme (Standard or Dark Mode)
- • Language preference
- • Include/exclude FAQ section
3. Making Changes
- 1.Update any fields you want to change in the modal
- 2.Use the design system tabs to customize colors, fonts, and layout
- 3.Click 'Save Changes' or 'Update Website' button
- 4.Wait 1-3 minutes for the AI to regenerate your site
- 5.Refresh your site URL to see the changes live
💡 Pro Tips:
- →Changes are regenerated by AI, so updates may take a few minutes
- →Your original site remains live until the update completes
- →You can make unlimited edits to refine your website
- →Experiment with different design systems to find the perfect look
✨ No Code Required!
The edit modal provides a user-friendly interface for all customizations. You don't need to know HTML, CSS, or any programming to create a beautiful, professional website.
Step 5: Add Custom Domain (Optional)
Connect your own domain name to your GitHub Pages or GitLab Pages website for a professional branded web address.
GitHub Pages Custom Domain Setup
Before you start: Purchase a domain from a registrar like Namecheap, GoDaddy, Google Domains, or Cloudflare. You'll need access to your domain's DNS settings.
Part 1: Configure DNS Records
Add these DNS records in your domain registrar's control panel:
For Apex Domain (example.com):
For Subdomain (www.example.com):
Part 2: Configure GitHub Repository
- 1.Go to your GitHub repository (the one GitPage created)
- 2.Click Settings → Pages (in the left sidebar)
- 3.Under "Custom domain", enter your domain (e.g.,
www.example.comorexample.com) - 4.Click Save
- 5.Wait for DNS check to complete (may take a few minutes)
- 6.Once verified, check "Enforce HTTPS" for secure connection
✓ That's it!
Your website should now be accessible at your custom domain. DNS changes can take up to 48 hours to propagate worldwide, but usually work within 1-2 hours.
Troubleshooting: If your domain doesn't work after 24 hours, verify your DNS records are correct and check GitHub Pages status.
GitLab Pages Custom Domain Setup
Before you start: Purchase a domain from a registrar like Namecheap, GoDaddy, Google Domains, or Cloudflare. You'll need access to your domain's DNS settings.
Part 1: Add Domain in GitLab
- 1.Go to your GitLab project (the one GitPage created)
- 2.Navigate to Settings → Pages (or Deploy → Pages)
- 3.Click "New Domain"
- 4.Enter your domain name (e.g.,
www.example.comorexample.com) - 5.Click "Create New Domain"
- 6.GitLab will show you the DNS records you need to add - keep this page open!
Part 2: Configure DNS Records
Add these DNS records in your domain registrar's control panel:
For Apex Domain (example.com):
For Subdomain (www.example.com):
For Domain Verification (TXT Record):
Part 3: Enable HTTPS
- 1.Wait for DNS to propagate (usually 1-2 hours, up to 48 hours)
- 2.Return to GitLab project → Settings → Pages
- 3.Find your domain in the list and click "Details"
- 4.If verification status shows ✓ Verified, you can enable automatic HTTPS certificate
- 5.GitLab will automatically provision a Let's Encrypt SSL certificate
✓ All Done!
Your website should now be accessible at your custom domain with HTTPS enabled. DNS changes can take up to 48 hours to propagate worldwide.
💡 Pro Tip: GitLab Pages supports wildcard domains and multiple custom domains per project. You can add both apex and www versions of your domain.
Troubleshooting: If verification fails, double-check your TXT record is correct. If HTTPS doesn't work, ensure your DNS records point correctly to GitLab Pages.
Common Custom Domain Issues
Domain not resolving?
- →DNS changes can take up to 48 hours to propagate
- →Verify DNS records are correct using a DNS checker tool
- →Clear your browser cache and try incognito mode
HTTPS not working?
- →Wait 24 hours after DNS propagation for SSL certificate provisioning
- →Ensure "Enforce HTTPS" is checked in GitHub Pages settings
- →For GitLab, verify your domain is showing as verified
Need help?
Check GitHub Pages Custom Domain Docs or GitLab Pages Custom Domain Docs