meyfa/atom-screenshot

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# atom-screenshot

**Atom editor plugin for creating code screenshots**

[![CI](https://github.com/meyfa/atom-screenshot/actions/workflows/main.yml/badge.svg)](https://github.com/meyfa/atom-screenshot/actions/workflows/main.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/a8715072f334495f9370/maintainability)](https://codeclimate.com/github/meyfa/atom-screenshot/maintainability)

| :warning: | Atom has been discontinued by GitHub[^1]. Since this project no longer serves a purpose, it won't be developed further, and has been archived. |
|-|:----|

[^1]: [Sunsetting Atom | The GitHub Blog (2022-06-08)](https://github.blog/2022-06-08-sunsetting-atom/)

With this package, you can take a screenshot of your code as it is shown in
Atom. With syntax highlighting and line numbers, but without any menus or
toolbars.

It captures every line from first to last into a single image by scrolling
through the file.

## Usage

You can invoke the package through the "screenshot:take" command, through the
"Packages" menu in the menu bar, or via the context menu. Note that a text
editor needs to be active so that this package knows which code to capture.

## Example

![Atom window with opened context menu showing the screenshot option](https://raw.githubusercontent.com/meyfa/atom-screenshot/master/images/context-menu.png)

This is the output image:

![Resulting screenshot image](https://raw.githubusercontent.com/meyfa/atom-screenshot/master/images/screenshot-take-result.png)