JavaScript CSS Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status styled with prettier PRs Welcome MIT License Greenkeeper badge

Deploy to now

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.

Community

Check out these projects our awesome community has created:

Contribute

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.

If you'd like to make some changes yourself, see the following:

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Make sure yarn is globally installed (npm install -g yarn)
  3. Run yarn to download required packages.
  4. Build and start the application: yarn dev
  5. If you contributed something new, run yarn contrib:add <your GitHub username> to add yourself below
  6. Finally, submit a pull request with your changes!

This project follows the all-contributors specification. Contributions of any kind are welcome!

A note on adding themes/languages

We're happy to accept any PRs adding new themes and languages to Carbon! Currently there are a few ways to do so:

  1. If the theme or language is supported in Codemirror, all you have to do is add a constant for it.

  2. If it's not supported, you can add a Codemirror compliant custom file to implement it and add a constant like above.

Thanks To

β–² ZEIT for sponsoring Carbon's hosting.

Authors

Carbon is a project by

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

πŸ’»