GitDoc

GitDoc is a VS Code extension that automatically generates comprehensive documentation for your code projects using AI. With just a keystroke, you can create detailed, readable documentation for individual files or your entire project.

Features

• Project Documentation: Generate complete documentation for your entire project with Ctrl+Alt+D (Cmd+Alt+D on Mac)
• Single File Documentation: Document just the current file with Ctrl+Alt+F (Cmd+Alt+F on Mac)
• Documentation Explorer: Easily browse and access all generated documentation
• Markdown Integration: View documentation directly in VS Code's markdown preview
• Customizable: Configure file types, excluded directories, and more

Requirements

• VS Code 1.60.0 or newer
• A Gemini API key (configured in extension settings)
• The documentation API server running locally or remotely

Getting Started

1. Install the extension from the VS Code Marketplace
2. Set your Gemini API key in the extension settings
3. Configure the API endpoint (default: http://localhost:8000)
4. Open a project folder
5. Press Ctrl+Alt+D (Cmd+Alt+D on Mac) to generate documentation

Extension Settings

This extension contributes the following settings:

• gitdoc.apiKey: Your Gemini API key for documentation generation
• gitdoc.apiEndpoint: Documentation API server endpoint
• gitdoc.excludeFolders: Folders to exclude from documentation
• gitdoc.fileExtensions: File extensions to include in documentation

Using the Extension

Generate Project Documentation

There are multiple ways to generate documentation for your entire project:

1. Press Ctrl+Alt+D (Cmd+Alt+D on Mac)
2. Run the command GitDoc: Generate Project Documentation from the command palette
3. Click the GitDoc status bar item
4. Right-click in the Explorer and select GitDoc: Generate Project Documentation

Document Current File

To generate documentation for just the current file:

1. Press Ctrl+Alt+F (Cmd+Alt+F on Mac)
2. Run the command GitDoc: Document Current File from the command palette
3. Right-click in the editor and select GitDoc: Document Current File

View Documentation

Generated documentation is:

1. Saved to a docs folder in your project
2. Available in the GitDoc Documentation Explorer panel
3. Automatically opened in VS Code's Markdown Preview

How It Works

1. GitDoc scans your project for supported code files
2. Files are analyzed by an AI documentation generator API
3. Documentation is created in well-structured Markdown format
4. A project summary is generated to provide high-level context
5. All documentation is saved to your project's docs directory

Running the Documentation API Server

This extension requires the accompanying Documentation API server to be running. See the documentation-api repository for setup instructions.

Release Notes

0.1.0

Initial release of GitDoc with:

• Project-wide documentation generation
• Single file documentation
• Documentation Explorer
• Customizable settings

Contributing

Contributions are welcome! See the contribution guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.