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.
carbon/README.md

28 KiB

maintained with Ranger All Contributors MIT License Join the community on Spectrum

Open Collective sponsors Open Collective backers Open Collective sponsors



Translations

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, 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

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.

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 below the 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. Visiting https://carbon.now.sh
  2. Clicking your browser's settings menu
  3. Clicking "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
  • Carbonize - A macOS wrapper with extended native features
  • CodeExpander - A smart GitHub gist client with the TextExpander features
  • nef - Export multiple Carbon code snippets from Xcode Playground.
Libraries
  • R carbonate - Iteratively manipulate image aesthetics in R and either open in Carbon or download directly.
Textbooks

Authors

Carbon is a project by:


Contribute & Support

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

Sponsors

Does your company use Carbon? Consider sponsoring the project to fund new features, bug fixes, and more.

Backers

Love using Carbon? Consider supporting the project to fund new features and improvements

Thanks To

▲ ZEIT for sponsoring Carbon's hosting.

Contributors

Contributors image

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

💻
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

🚇
Munieru
Munieru

🌍
Adam Lusted
Adam Lusted

💻
Jose Noriega
Jose Noriega

🌍