Carbon

Create and share beautiful images of your source code

README

maintained with Ranger All Contributors MIT License FOSSA Status




Translations

Español हिंदी Deutsch 简体中文 Português
മലയാളം Türkçe 한국어 தமிழ் Français
日本語 Svenska Polski Nederlands 正體中文
Indonesia Українська Italiano עברית Русский
العربية Add +

Introduction


You know all of those code screenshots 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.

Carbon example


Features


- Customization. Customize things like your image's syntax theme, font style, and more
- Share quickly. Save your image or
  a link with one click
- Save snippets. Create an account to save snippets for later. Shared snippets are automatically unfurled on Twitter and Slack.

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/`](https://carbon.now.sh/3208813b324d82a9ebd197e4b1c3bae8))
- Or just start typing!

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, padding, shadows, fonts, and more.

Exporting & Sharing


After you've customized your image you can share your snippet in a number of ways

Create a saved snippet

Sharing a saved snippet will automatically unfurl the image on platforms like Twitter and Slack. This lets users see your creation, while also giving them access to the source code via the link. Better yet, if you need to make an update, simply follow the link yourself to edit the snippet directly.

To create a saved snippet:

1. Login using the "Sign in/Sign up" button
2. Edit as you normally would — your snippet will get saved automatically
3. Copy the URL from your browser window and share away!

Embed a snippet

This is the recommended method for sharing Carbon on your own website or blog. Readers can even copy the code with the click of a button.

You can embed any Carbon snippet in your website directly using the carbon.now.sh/embed URL. The "Copy Menu" lets you quickly copy the correct iFrame snippet, or the encoded URL for embedding on platforms like Medium.

Finally, you can also embed saved snippets or GitHub gists using carbon.now.sh/embed/:id.

Use the Tweet button

The Tweet button will not only share the image on Twitter, but it will also correctly encode the alt text to ensure your images are accessible. However, if you want to tweet image yourself, please check out how to make your Twitter images accessible.

Download the image directly

Carbon supports downloading your image as a PNG and SVG. You can also click Export → Open to open your image directly in the browser. Finally, you can copy the Carbon image directly to your clipboard by going to Copy → Image.

Installing Carbon for Desktop (Offline)


If you are using Google Chrome, or another browser that supports Progressive Web Apps, you can install Carbon for use offline by:

1. Visit carbon.now.sh
2. Click your browser's settings menu
3. Click "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
- [Xcode nef](https://github.com/bow-swift/nef-plugin) - This Xcode extension enables you to export a code selection as a Carbon snippet in a single action

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
- CodeExpander - 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.
- [@carbonshbot](https://t.me/carbonshbot) - A Telegram chatbot wich takes in a code snippet or gist URL and generates an Carbon image
- [R carbonate](https://yonicd.github.io/carbonate/) - Iteratively manipulate image aesthetics in R and either open in Carbon or download directly.
- Carbon for Slack - Use Carbon directly in Slack. Just invoke the/carbon command.

Citations

- "CS 101 - An Introduction to Computational Thinking" - a computer science textbook by Sarbo Roy.

Authors


Carbon is a project by:

- Mike Fix (@mfix22)
- Brian Dennis (@briandennis)
- Jake Dexheimer (@jakedex)

License

FOSSA Status




Contribute & Support


Pull requests are welcome! Please see our contributing guidelines for more details.

Sponsors & Backers

Fossa
Powered by Vercel


Thanks To


▲ Vercel for sponsoring Carbon's hosting.

All Contributors


Thanks goes out to all these wonderful people (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

💻
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

🚇
Munieru
Munieru

🌍
Adam Lusted
Adam Lusted

💻
Jose Noriega
Jose Noriega

🌍
Merlin Fuchs
Merlin Fuchs

🌍
Ramy Majouji
Ramy Majouji

💻
Viktor Nemes
Viktor Nemes

💻
Eric Bailey
Eric Bailey

💻
Nazeefa
Nazeefa

🌍
Pratik Butani
Pratik Butani

📝
Bakti Aditya
Bakti Aditya

💻
Caleb Taylor
Caleb Taylor

💻
Rogério Munhoz
Rogério Munhoz

💻
Technoknol
Technoknol

💻
Tymoteusz Makowski
Tymoteusz Makowski

💻
Nisar Hassan Naqvi
Nisar Hassan Naqvi

🐛
Ilyas Karim
Ilyas Karim

🐛
Nick Fix
Nick Fix

🤔
Melanie Sumner
Melanie Sumner

🤔
aluc
aluc

💻
B. Mearns
B. Mearns

🤔
Peng Jie
Peng Jie

💻
Binyamin Aron Green
Binyamin Aron Green

💻
Michal
Michal

🌍
Quinn Blenkinsop
Quinn Blenkinsop

💻
Dwiferdio Seagal Putra
Dwiferdio Seagal Putra

💻
Ashley Woodall Clark
Ashley Woodall Clark

💻
Tim Wienk
Tim Wienk

🌍
George McCarron
George McCarron

📖
Erwin Rahayu
Erwin Rahayu

🌍 📖
Luca
Luca

💻
Andrew Hayes
Andrew Hayes

💻
Bereket Semagn
Bereket Semagn

💻
Lorenzo Lancia
Lorenzo Lancia

🌍
Guy Adler
Guy Adler

🌍
Dan Bamikiya
Dan Bamikiya

🤔
kewang
kewang

🌍
Rizda Dwi Prasetya
Rizda Dwi Prasetya

🖋
AbreuY
AbreuY

🌍
>_Rizky.dev
>_Rizky.dev

🌍 📖
Abidemi Harry
Abidemi Harry

💻
Marco
Marco

🌍
Sam Robbins
Sam Robbins

📖
alceil
alceil

💻
hatsu
hatsu

💻
Praveen Kumar Purushothaman
Praveen Kumar Purushothaman

🌍