All Contributors styled with prettier MIT License Greenkeeper badge Join the community on Spectrum FOSSA Status



[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/dawnlabs/carbon) ##### 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) - [日本語](/docs/README.ja.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. ## Features - **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 - **Import from GitHub gist**. Simply append a GitHub gist id to the url ## Example

## 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 'Tweet' 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. #### Installing Carbon for Desktop If you are using Google Chrome, or another browser that supports Progressive Web Apps, you can install Carbon for use offline by clicking your browser's settings menu and then "Install Carbon..." ## 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 - [`nef`](https://github.com/bow-swift/nef#-exporting-carbon-code-snippets) - Export multiple Carbon code snippets from `Xcode Playground`. ##### 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: - Mike Fix ([@mfix22](https://twitter.com/fixitup2)) - 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)):
briandennis
briandennis

💻 📖 🚇 👀
mfix22
mfix22

💬 💻 🤔
jakedex
jakedex

💬 💻 🎨 📹
andrewda
andrewda

💬 💻 🐛 👀
yeskunall
yeskunall

💻 📖 🔧 🐛
stoshfabricius
stoshfabricius

💻
jkling38
jkling38

📖
otobrglez
otobrglez

💻
darahak
darahak

📖
dom96
dom96

💻
elrumordelaluz
elrumordelaluz

💻
cjb
cjb

💻
Krzysztof-Cieslak
Krzysztof-Cieslak

💻
fernahh
fernahh

📖
g3r4n
g3r4n

💻
Mat Gadd
Mat Gadd

🐛 💻
Brad Davies
Brad Davies

🐛 💻
Rafael Câmara
Rafael Câmara

💻
Gleb Bahmutov
Gleb Bahmutov

⚠️ 🔧
Iván Munguía
Iván Munguía

💻
Dillon Mulroy
Dillon Mulroy

💻
Nihad Abbasov
Nihad Abbasov

💻
Hugo Torzuoli
Hugo Torzuoli

📖
Bruno C. Couto
Bruno C. Couto

💻
Mark Molnar
Mark Molnar

💻
Takahiko Inayama
Takahiko Inayama

💻
François Martin
François Martin

💻
Raphael Amorim
Raphael Amorim

💻
Camron Flanders
Camron Flanders

💻
Eric Adamski
Eric Adamski

💻
Winner Crespo
Winner Crespo

💻 🎨
Milos
Milos

💻 🔧 📖 🌍
Yashu Mittal
Yashu Mittal

💻
Rachel M. Carmena
Rachel M. Carmena

📖
Miguel Salazar
Miguel Salazar

📖 🌍
Vyom Jain
Vyom Jain

📖 🌍
racaljk
racaljk

🌍
Sean
Sean

💻
Izabela Borges
Izabela Borges

🌍
Shinil M S
Shinil M S

🌍
Berke Atac
Berke Atac

🌍
LEE YONGJUN
LEE YONGJUN

🌍
Matthew Nielsen
Matthew Nielsen

💻
Boy
Boy

📦
Vetrivel Chinnasamy
Vetrivel Chinnasamy

🌍
Farzad YZ
Farzad YZ

💻 🤔
Yannick Loriot
Yannick Loriot

🌍
Joel Hanson
Joel Hanson

💻
Muhammad Muzzammil
Muhammad Muzzammil

💻
souppower
souppower

🚇
Masato Urai (@uraway_)
Masato Urai (@uraway_)

🌍
Fernando
Fernando

🌍
Megha Sachdev
Megha Sachdev

💻 ⚠️
Anudeep Reddy
Anudeep Reddy

🚇