Skip to content
Chris Watson edited this page Nov 20, 2024 · 4 revisions

Welcome to Goshot

Goshot is a powerful Go library and CLI tool for creating beautiful code screenshots with customizable window chrome, syntax highlighting, and backgrounds. Similar to Carbon and Silicon, Goshot allows you to create stunning visual representations of your code snippets for documentation, presentations, or social media sharing.

Example

Go Reference Go Report Card License

Key Features

  • 🎨 Beautiful syntax highlighting with multiple themes
  • πŸ–Ό Customizable window chrome (macOS, Windows, Linux styles)
  • 🌈 Various background options (solid colors, gradients, images)
  • πŸ”€ Custom font support
  • πŸ“ Adjustable padding and margins
  • πŸ’Ύ Multiple export formats (PNG, JPEG)
  • πŸ›  Both CLI and library interfaces

Quick Navigation

  • Installation Guide - Instructions for installing both the CLI tool and library
  • CLI Usage - Learn how to use Goshot from the command line (coming soon)
  • Library Usage - Examples and documentation for using Goshot as a library

Project Status

Goshot is currently under active development. While the core functionality is stable, some features are still being implemented and refined. Check the project roadmap for more information about upcoming features and improvements.

Clone this wiki locally