← Back to Git2Docs
Quick Start

From repo to published docs in 5 minutes

Try Git2Docs with pre-configured example repositories. Fork, connect, click generate. No credit card required.

Get started in three steps

  • 1
    Fork an example repo
    Choose one of our pre-configured example repositories and fork it to your GitHub account.
  • 2
    Connect & configure
    Sign in, connect your fork via GitHub App, and upload the provided config file.
  • 3
    Generate docs
    Click 'Generate Documentation' and watch AI create comprehensive docs in minutes.

Choose an example repository

Pick one based on your tech stack or how much time you have. All configs are pre-tuned for great results.

envconfig

kelseyhightower/envconfig
Go

Go library for managing configuration from environment variables

Size
Tiny
Time
2–3 min
Output
8–10 pages
Why this example
  • Perfect first try — smallest example
  • Focused library with clear purpose
  • Great for testing the platform quickly
Fork on GitHubDownload config

Chalk

chalk/chalk
JavaScript

Terminal string styling library for Node.js

Size
Small
Time
3–4 min
Output
12–15 pages
Why this example
  • Popular npm package with clear API
  • Beginner-friendly documentation
  • Good example of library docs
Fork on GitHubDownload config

Detailed step-by-step

1Fork the example repository

  1. Choose one of the example repos above
  2. Click the repository link to open it on GitHub
  3. Click the "Fork" button in the top right
  4. Select your personal account as the destination
  5. Wait for GitHub to create the fork (takes a few seconds)

2Connect your repository

  1. Sign in to Git2Docs with your GitHub account
  2. In your dashboard, click "Connect GitHub Repositories"
  3. Select your forked repository from the list
  4. Click "Install" to authorize the Git2Docs GitHub App
  5. You'll be redirected back to your dashboard

3Upload configuration

  1. Download the config file for your chosen example (links above)
  2. In your dashboard, click on your connected repository
  3. Click "Configuration" tab
  4. Click "Upload YAML" or drag and drop the config file
  5. Review the configuration and click "Save"

4Generate documentation

  1. Navigate to the "Generate" tab
  2. Select the version/branch (usually "main" or "master")
  3. Click "Generate Documentation"
  4. Watch the progress indicator as AI analyzes your code
  5. Stages: Cloning → Comprehending → Planning → Generating → Validating
  6. When complete, click "View Documentation"
What to expect: Generation typically runs 2–7 minutes depending on repo size. You'll get a Getting Started guide, full API reference, usage examples, an architecture overview, and best-practice notes — all editable with AI assistance.

After generating your first docs

  • Review and edit the generated documentation
  • Publish your docs to make them public
  • Set up a custom domain (optional)
  • Connect your own repository and create production docs
  • Explore advanced features like version management and changelog generation
Get started nowRead full documentation

Frequently asked questions

Do I need to keep the forked repository?

No — once you've tested Git2Docs with the example, you can delete the fork. The generated documentation will remain in your Git2Docs account.

Can I use my own repository instead?

Absolutely. These examples are just to help you understand the workflow. Once you're comfortable, connect any repository you own and generate docs for it.

What if the config file doesn't work?

Our configs are pre-tested, but if you run into issues, our auto-detection can generate a config for you. Just skip the upload step and click 'Generate Config' instead.

How much does it cost to generate documentation?

Documentation generation is included in your plan — see the pricing page for Builder, Team, and Enterprise tiers. You'll always see usage and any projected overage on your billing dashboard before a period closes.

Can I regenerate documentation if I make changes?

Yes — Git2Docs can sync with new releases and regenerate docs incrementally, only updating sections affected by code changes.