Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dawnlabs/carbon

:black_heart: Create and share beautiful images of your source code
https://github.com/dawnlabs/carbon

beautiful carbon education github-gist javascript presentation sharing snippets tweet

Last synced: 8 days ago
JSON representation

:black_heart: Create and share beautiful images of your source code

Host: GitHub
URL: https://github.com/dawnlabs/carbon
Owner: carbon-app
License: mit
Created: 2017-06-16T02:50:28.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-08-02T03:08:17.000Z (4 months ago)
Last Synced: 2024-08-04T00:06:44.180Z (4 months ago)
Topics: beautiful, carbon, education, github-gist, javascript, presentation, sharing, snippets, tweet
Language: JavaScript
Homepage: https://carbon.now.sh
Size: 19.7 MB
Stars: 34,355
Watchers: 247
Forks: 1,907
Open Issues: 82
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-star-libs - dawnlabs / carbon
awesome - carbon - 🎨 Create and share beautiful images of your source code (JavaScript)
Starred-Repo - Carbon: Programming Screenshot
awesome-harmony - Carbon - 创建并共享源代码的精美图片 (DevEco 插件 / 免费版)
starred-awesome - carbon - 🎨 Create and share beautiful images of your source code (JavaScript)

README

        


  





  

    

  

  

    

  

  

    

  

  

    

  






##### Translations

  

    

      

        Español

      

      

        हिंदी

      

      

        Deutsch

      

      

        简体中文

      

      

        Português

      

    

    

      

        മലയാളം

      

      

        Türkçe

      

      

        한국어

      

      

        தமிழ்

      

      

        Français

      

    

    

      

        日本語

      

      

        Svenska

      

      

        Polski

      

      

        Nederlands

      

      

        正體中文

      

    

    

      

        Indonesia

      

      

        Українська

      

      

        Italiano

      

      

        עברית

      

      

        Русский

      

    

    

      

        العربية

      

      

        বাংলা

      

      

        Add +

      

    

  

## Introduction

You know [all](https://twitter.com/dan_abramov/status/890191815567175680) [of those](https://twitter.com/reactjs/status/890511993261654017) [code screenshots](https://twitter.com/notquiteleo/status/873483329345028096) 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.



  



## 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](https://help.twitter.com/en/using-twitter/picture-descriptions).

##### 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](https://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](https://codeexpander.com) - 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 which 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](https://github.com/faisalsayed10/carbon-slack) - Use Carbon directly in Slack. Just invoke the `/carbon` command.

##### Citations

- ["CS 101 - An Introduction to Computational Thinking"](https://itunes.apple.com/us/book/id1435714196) - a computer science textbook by Sarbo Roy.

## Authors

Carbon is a project by:

- Mike Fix ([@mfix22](https://twitter.com/fixitup2))

- Brian Dennis ([@briandennis](https://github.com/briandennis))

- Jake Dexheimer ([@jakedex](https://github.com/jakedex))

#### License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcarbon-app%2Fcarbon.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcarbon-app%2Fcarbon?ref=badge_large)







---

## Contribute & Support

Pull requests are welcome! Please see our [contributing guidelines](/.github/CONTRIBUTING.md) for more details.

### Sponsors & Backers

[![Fossa](https://assets-global.website-files.com/5f4d9ea2592c16056cb0f7a5/5f4d9ea2592c16d9a2b0f7da_logo-FOSSA-night-blue.svg)](https://fossa.com)

[![Powered by Vercel](https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg)](https://vercel.com?utm_source=carbon-app&utm_campaign=oss)

















### Thanks To

[▲ Vercel](https://vercel.com?utm_source=carbon-app&utm_campaign=oss) for sponsoring Carbon's hosting.

### All Contributors

Thanks goes out to all these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#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
💻

    
_{Praveen Kumar Purushothaman}
🌍

  

  

    
_{Amir Elsagan}
🌍

    
_korzck
🌍

    
_{Sakibul Alam}
🌍