carbon/README.md

Translations

• Español
• हिंदी
• Deutsch
• 简体中文
• Português
• മലയാളം
• Türkçe
• 한국어
• தமிழ்
• Français

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.

Visit carbon.now.sh or read our post 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

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.

Community

Check out these projects our awesome community has created:

Editor Plugins

• IntelliJ IDEA carbon-now-sh - Open up the selection in your current IntelliJ IDEA file in Carbon through a context menu
• Atom carbon-now-sh - Open up your current Atom file in Carbon with shift-cmd-A
• VS Code carbon-now-sh - Open up your current VS Code file in Carbon with command carbon
• Sublime Text 3 carbon-now-sh - Open up the selection in your current Sublime Text 3 file with a custom bound key
• Vim carbon-now-sh - Open up the selection in your current Vim/Neovim using function CarbonNowSh()
• Emacs carbon-now-sh - Open up the selection in your current Emacs using interactive function carbon-now-sh

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

Libraries

• R carbonate - Iteratively manipulate image aesthetics in R and either open in Carbon or download directly.

Textbooks

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

Contribute

PRs welcome! Please see our CONTRIBUTING.md for more details.

Thanks To

▲ ZEIT for sponsoring Carbon's hosting.

Authors

Carbon is a project by

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

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 💻	Hugo Torzuoli 📖	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 🌍