carbon README

The project's README from github.com/carbon-app/carbon. As one markdown file: 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

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

💻

carbon (carbon-app/carbon)

Searching Database…

36.1K ·GitHub
What is this?Carbon is a web app for turning your source code into a beautiful, shareable image — great for posting code snippets on Twitter, Slack, or a blog.
Is this a desktop app or something I use in the browser?It is primarily a website (carbon.now.sh) built with Next.js, but Chrome and other PWA-capable browsers let you 'install' it so it works offline like a desktop app.
How do I get my code into Carbon?You can drop a code file onto the editor, just start typing/pasting code directly, or append a GitHub gist ID to the URL (e.g. carbon.now.sh/ ).
Do I need to sign up to make an image?No, you can create and export an image without an account; signing in is only needed if you want to save a snippet so it stays editable via a shareable link.
Does offline use work in any browser?Offline installation only works in Chrome or other browsers that support Progressive Web Apps — it's not available everywhere by default.
What image formats can I export to?Carbon can export your snippet as a PNG or SVG, and you can also copy the rendered image straight to your clipboard.
Are there editor integrations for Carbon?The community has built plugins for VS Code, Vim/Neovim, Emacs, Sublime Text, Atom, IntelliJ IDEA, and Xcode, plus a standalone CLI tool called carbon-now-cli.
Can I embed a Carbon snippet on my own website?Yes — any saved snippet or gist can be embedded via carbon.now.sh/embed/:id, with a ready-made iframe snippet or encoded URL for platforms like Medium.
What are similar projects?Lepton, remark, VibeOffice, ascii, magicui, whirl, cult-ui, apexcharts.js
Creator
carbon-app
Size
20.6 MB
Stars
36.1K
Age
9y
Commits · 90 Days