๐Ÿ–ค Create and share beautiful images of your source code
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
korzck 8402ee07ec Added russian translation 2 years ago
.github Update CONTRIBUTING.md 3 years ago
bin use vercel instead of now (#1266) 3 years ago
components Fix exported image cut off - Safari 2 years ago
cypress fix issue 1347 (#1348) 3 years ago
docs Added russian translation 2 years ago
lib add Stan language 2 years ago
pages add keyboard listener 3 years ago
public update robots.txt 4 years ago
.all-contributorsrc update .all-contributorsrc to fix/remove broken users 2 years ago
.eslintrc.js eslint config for nextjs (#1322) 3 years ago
.gitignore use vercel instead of now (#1266) 3 years ago
.npmrc add registry to npmrc 6 years ago
.prettierrc Upgrade dependencies (#981) 5 years ago
.vercelignore .vercelignore 3 years ago
LICENSE Update LICENSE 3 years ago
README.md Added russian translation 2 years ago
SECURITY.md Create SECURITY.md 3 years ago
next.config.js fix issue 1347 (#1348) 3 years ago
package.json 4.9.10 2 years ago
release.js try our `now-release` 6 years ago
vercel.json update vercel.json functions 3 years ago
yarn.lock Bump vm2 from 3.9.9 to 3.9.11 2 years ago

README.md

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:

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
Tools
  • CLI 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 - Export multiple Carbon code snippets from Xcode Playground.
  • @carbonshbot - A Telegram chatbot wich takes in a code snippet or gist URL and generates an Carbon image
  • R 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

Authors

Carbon is a project by:

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

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡ ๐Ÿ‘€

mfix22

๐Ÿ’ฌ ๐Ÿ’ป ๐Ÿค”

jakedex

๐Ÿ’ฌ ๐Ÿ’ป ๐ŸŽจ ๐Ÿ“น

andrewda

๐Ÿ’ฌ ๐Ÿ’ป ๐Ÿ› ๐Ÿ‘€

yeskunall

๐Ÿ’ป ๐Ÿ“– ๐Ÿ”ง ๐Ÿ›

stoshfabricius

๐Ÿ’ป

jkling38

๐Ÿ“–

otobrglez

๐Ÿ’ป

darahak

๐Ÿ“–

dom96

๐Ÿ’ป

elrumordelaluz

๐Ÿ’ป

cjb

๐Ÿ’ป

Krzysztof-Cieslak

๐Ÿ’ป

fernahh

๐Ÿ“–

g3r4n

๐Ÿ’ป

Mat Gadd

๐Ÿ› ๐Ÿ’ป

Brad Davies

๐Ÿ› ๐Ÿ’ป

Rafael Cรขmara

๐Ÿ’ป

Gleb Bahmutov

โš ๏ธ ๐Ÿ”ง

Ivรกn Munguรญa

๐Ÿ’ป

Dillon Mulroy

๐Ÿ’ป

Nihad Abbasov

๐Ÿ’ป

Bruno C. Couto

๐Ÿ’ป

Mark Molnar

๐Ÿ’ป

Takahiko Inayama

๐Ÿ’ป

Franรงois Martin

๐Ÿ’ป

Raphael Amorim

๐Ÿ’ป

Camron Flanders

๐Ÿ’ป

Eric Adamski

๐Ÿ’ป

Winner Crespo

๐Ÿ’ป ๐ŸŽจ

Milos

๐Ÿ’ป ๐Ÿ”ง ๐Ÿ“– ๐ŸŒ

Yashu Mittal

๐Ÿ’ป

Rachel M. Carmena

๐Ÿ“–

Miguel Salazar

๐Ÿ“– ๐ŸŒ

Vyom Jain

๐Ÿ“– ๐ŸŒ

racaljk

๐ŸŒ

Sean

๐Ÿ’ป

Izabela Borges

๐ŸŒ

Shinil M S

๐ŸŒ

Berke Atac

๐ŸŒ

LEE YONGJUN

๐ŸŒ

Matthew Nielsen

๐Ÿ’ป

Boy

๐Ÿ“ฆ

Vetrivel Chinnasamy

๐ŸŒ

Farzad YZ

๐Ÿ’ป ๐Ÿค”

Yannick Loriot

๐ŸŒ

Joel Hanson

๐Ÿ’ป

Muhammad Muzzammil

๐Ÿ’ป

souppower

๐Ÿš‡

Masato Urai (@uraway_)

๐ŸŒ

Fernando

๐ŸŒ

Megha Sachdev

๐Ÿ’ป โš ๏ธ

Anudeep Reddy

๐Ÿš‡

Munieru

๐ŸŒ

Adam Lusted

๐Ÿ’ป

Jose Noriega

๐ŸŒ

Merlin Fuchs

๐ŸŒ

Ramy Majouji

๐Ÿ’ป

Viktor Nemes

๐Ÿ’ป

Eric Bailey

๐Ÿ’ป

Nazeefa

๐ŸŒ

Pratik Butani

๐Ÿ“

Bakti Aditya

๐Ÿ’ป

Caleb Taylor

๐Ÿ’ป

Rogรฉrio Munhoz

๐Ÿ’ป

Technoknol

๐Ÿ’ป

Tymoteusz Makowski

๐Ÿ’ป

Nisar Hassan Naqvi

๐Ÿ›

Ilyas Karim

๐Ÿ›

Nick Fix

๐Ÿค”

Melanie Sumner

๐Ÿค”

aluc

๐Ÿ’ป

B. Mearns

๐Ÿค”

Peng Jie

๐Ÿ’ป

Binyamin Aron Green

๐Ÿ’ป

Michal

๐ŸŒ

Quinn Blenkinsop

๐Ÿ’ป

Dwiferdio Seagal Putra

๐Ÿ’ป

Ashley Woodall Clark

๐Ÿ’ป

Tim Wienk

๐ŸŒ

George McCarron

๐Ÿ“–

Erwin Rahayu

๐ŸŒ ๐Ÿ“–

Luca

๐Ÿ’ป

Andrew Hayes

๐Ÿ’ป

Bereket Semagn

๐Ÿ’ป

Lorenzo Lancia

๐ŸŒ

Guy Adler

๐ŸŒ

Dan Bamikiya

๐Ÿค”

kewang

๐ŸŒ

Rizda Dwi Prasetya

๐Ÿ–‹

AbreuY

๐ŸŒ

>_Rizky.dev

๐ŸŒ ๐Ÿ“–

Abidemi Harry

๐Ÿ’ป

Marco

๐ŸŒ

Sam Robbins

๐Ÿ“–

alceil

๐Ÿ’ป

hatsu

๐Ÿ’ป