carbon/README.md

<p align="center"><img width=100% src="https://user-images.githubusercontent.com/10369094/31211729-591d059c-a950-11e7-86af-fa5ea3d7dbac.png"></p>

<!--[![Dependencies](https://img.shields.io/david/dawnlabs/carbon.svg)](https://github.com/dawnlabs/carbon/blob/readme-badges/package.json)-->

[![All Contributors](https://img.shields.io/badge/all_contributors-48-orange.svg?style=flat-square)](#contributors)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![MIT License](https://img.shields.io/github/license/dawnlabs/carbon.svg)](https://github.com/dawnlabs/carbon/blob/master/LICENSE)
[![Greenkeeper badge](https://badges.greenkeeper.io/dawnlabs/carbon.svg)](https://greenkeeper.io/)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/carbon-now)
<br></br>
[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/dawnlabs/carbon&env=TWITTER_CONSUMER_KEY&env=TWITTER_CONSUMER_SECRET&env=TWITTER_ACCESS_TOKEN_KEY&env=TWITTER_ACCESS_TOKEN_SECRET&env=LOGS_SECRET_PREFIX)

##### Translations

- [Español](/docs/README.es.md)
- [हिंदी](/docs/README.hi.md)
- [Deutsch](/docs/README.de.md)
- [简体中文](/docs/README.cn.zh.md)
- [Português](/docs/README.br.pt.md)
- [മലയാളം](/docs/README.ml.md)
- [Türkçe](/docs/README.tr.md)
- [한국어](/docs/README.kr.md)
- [தமிழ்](/docs/README.ta.md)
- [Français](/docs/README.fr.md)

## Introduction

You know [all](https://twitter.com/dan_abramov/status/890191815567175680) [of](https://twitter.com/reactjs/status/890511993261654017) [those code](https://twitter.com/notquiteleo/status/873483329345028096) [screenshots](https://twitter.com/zeithq/status/805779711154647040) you see on Twitter? Though the code's usually impressive, we saw room for improvement in the aesthetic department. Carbon makes it easy to create and share beautiful images of your source code. So what are you waiting for? Go impress all of your followers with your newfound design prowess.

Visit [carbon.now.sh](https://carbon.now.sh) or read [our post](https://dawnlabs.io/case-studies/carbon/) to learn more about the project.

## Features

- **Import from GitHub gist**. Simply append a GitHub gist id to the url
- **Customization**. Customize things like your image's syntax theme, window style, and more
- **Share quickly**. Save your image or Tweet a link with one click

## Example

<p align="center"><img width=100% src="https://user-images.githubusercontent.com/10369094/30791512-cb001438-a167-11e7-952b-f0f0e5c4499e.png"></p>

## Usage

#### Import

There are a few different ways to import code into Carbon:

- Drop a file onto the editor
- Append a GitHub gist id to the url (e.g. `carbon.now.sh/GIST_ID_HERE`)
- Paste your code directly

#### Customization

Once you've got all of your code into Carbon, you can customize your image by changing the syntax theme, background color, window theme, or padding.

#### Export/Sharing

After you've customized your image you can either Tweet a link to the image, or save it directly.

If you use the &apos;Tweet&apos; button, Carbon will automatically make your image accessible. However, if you want to manually tweet your carbon image, please check out [how to make your Twitter images accessible](https://help.twitter.com/en/using-twitter/picture-descriptions).

If you include a Carbon image in a post, the source code will be invisible for assistive technology, it will not be possible to enlarge it or copy it, etc. Please, think about adding another element with the source code as text, like an [HTML Details Element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details) below the image.

## Community

Check out these projects our awesome community has created:

##### Editor Plugins

- [IntelliJ IDEA `carbon-now-sh`](https://plugins.jetbrains.com/plugin/10469-carbon-now-sh) - Open up the selection in your current IntelliJ IDEA file in Carbon through a context menu
- [Atom `carbon-now-sh`](https://atom.io/packages/carbon-now-sh) - Open up your current Atom file in Carbon with `shift-cmd-A`
- [VS Code `carbon-now-sh`](https://marketplace.visualstudio.com/items?itemName=ericadamski.carbon-now-sh) - Open up your current VS Code file in Carbon with command `carbon`
- [Sublime Text 3 `carbon-now-sh`](https://github.com/molnarmark/carbonSublime) - Open up the selection in your current Sublime Text 3 file with a custom bound key
- [Vim `carbon-now-sh`](https://github.com/kristijanhusak/vim-carbon-now-sh) - Open up the selection in your current Vim/Neovim using function `CarbonNowSh()`
- [Emacs `carbon-now-sh`](https://github.com/veelenga/carbon-now-sh.el) - Open up the selection in your current Emacs using interactive function `carbon-now-sh`
- [Xcode `carbon-now-sh`](https://github.com/StevenMagdy/CarboNow4Xcode) - Open up your current selection in  `carbon.now.sh`

##### Tools

- [CLI `carbon-now-cli`](https://github.com/mixn/carbon-now-cli) - Open a file in Carbon or download it directly using `carbon-now`, featuring an interactive mode, selective highlighting and more
- [Carbonize](https://itunes.apple.com/us/app/carbonize/id1451177988) - A macOS wrapper with extended native features
- [CodeExpander](https://codeexpander.com) - A smart GitHub gist client with the TextExpander features

##### Libraries

- [R `carbonate`](https://yonicd.github.io/carbonate/) - Iteratively manipulate image aesthetics in `R` and either open in Carbon or download directly.

##### Textbooks

- ["CS 101 - An Introduction to Computational Thinking"](https://itunes.apple.com/us/book/id1435714196) - a computer science textbook by Sarbo Roy.

## Contribute

PRs welcome! Please see our [CONTRIBUTING.md](https://github.com/dawnlabs/carbon/blob/master/.github/CONTRIBUTING.md) for more details.

## Thanks To

[ ▲ ZEIT ](https://zeit.co/) for sponsoring Carbon's hosting.

## Authors

Carbon is a project by <a href="http://dawnlabs.io/"><img width=8% src="https://cloud.githubusercontent.com/assets/10369094/25406306/dacebd4c-29cb-11e7-8e1c-468687cde495.png"></a>

- Mike Fix ([@mfix22](https://github.com/mfix22))
- Brian Dennis ([@briandennis](https://github.com/briandennis))
- Jake Dexheimer ([@jakedex](https://github.com/jakedex))

## Contributors

Thanks goes out to all these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table cellspacing="0" cellpadding="1"><tr><td><a href="https://github.com/briandennis"><img src="https://avatars0.githubusercontent.com/u/10078572?v=4" width="100px;" height="100px;" alt="briandennis"/><br /><sub><b>briandennis</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=briandennis" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/commits?author=briandennis" title="Documentation">📖</a> <a href="#infra-briandennis" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#review-briandennis" title="Reviewed Pull Requests">👀</a></td><td><a href="https://github.com/mfix22"><img src="https://avatars0.githubusercontent.com/u/8397708?v=4" width="100px;" height="100px;" alt="mfix22"/><br /><sub><b>mfix22</b></sub></a><br /><a href="#question-mfix22" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=mfix22" title="Code">💻</a> <a href="#ideas-mfix22" title="Ideas, Planning, & Feedback">🤔</a></td><td><a href="https://github.com/jakedex"><img src="https://avatars1.githubusercontent.com/u/10369094?v=4" width="100px;" height="100px;" alt="jakedex"/><br /><sub><b>jakedex</b></sub></a><br /><a href="#question-jakedex" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=jakedex" title="Code">💻</a> <a href="#design-jakedex" title="Design">🎨</a> <a href="#video-jakedex" title="Videos">📹</a></td><td><a href="https://github.com/andrewda"><img src="https://avatars1.githubusercontent.com/u/10191084?v=4" width="100px;" height="100px;" alt="andrewda"/><br /><sub><b>andrewda</b></sub></a><br /><a href="#question-andrewda" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=andrewda" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/issues?q=author%3Aandrewda" title="Bug reports">🐛</a> <a href="#review-andrewda" title="Reviewed Pull Requests">👀</a></td><td><a href="https://github.com/yeskunall"><img src="https://avatars2.githubusercontent.com/u/14703164?v=4" width="100px;" height="100px;" alt="yeskunall"/><br /><sub><b>yeskunall</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=yeskunall" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/commits?author=yeskunall" title="Documentation">📖</a> <a href="#tool-yeskunall" title="Tools">🔧</a> <a href="https://github.com/dawnlabs/carbon/issues?q=author%3Ayeskunall" title="Bug reports">🐛</a></td><td><a href="https://github.com/stoshfabricius"><img src="https://avatars1.githubusercontent.com/u/2652676?v=4" width="100px;" height="100px;" alt="stoshfabricius"/><br /><sub><b>stoshfabricius</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=stoshfabricius" title="Code">💻</a></td><td><a href="https://github.com/jkling38"><img src="https://avatars1.githubusercontent.com/u/11639896?v=4" width="100px;" height="100px;" alt="jkling38"/><br /><sub><b>jkling38</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=jkling38" title="Documentation">📖</a></td></tr><tr><td><a href="https://github.com/otobrglez"><img src="https://avatars1.githubusercontent.com/u/225946?v=4" width="100px;" height="100px;" alt="otobrglez"/><br /><sub><b>otobrglez</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=otobrglez" title="Code">💻</a></td><td><a href="https://github.com/darahak"><img src="https://avatars3.githubusercontent.com/u/11488612?v=4" width="100px;" height="100px;" alt="darahak"/><br /><sub><b>darahak</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=darahak" title="Documentation">📖</a></td><td><a href="https://github.com/dom96"><img src="https://avatars0.githubusercontent.com/u/246651?v=4" width="100px;" height="100px;" alt="dom96"/><br /><sub><b>dom96</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=dom96" title="Code">💻</a></td><td><a href="https://github.com/elrumordelaluz"><img src="ht
<!-- ALL-CONTRIBUTORS-LIST:END -->