8402ee07ec
|
2 years ago | |
|---|---|---|
| .github | 3 years ago | |
| bin | 3 years ago | |
| components | 2 years ago | |
| cypress | 3 years ago | |
| docs | 2 years ago | |
| lib | 2 years ago | |
| pages | 3 years ago | |
| public | 4 years ago | |
| .all-contributorsrc | 3 years ago | |
| .eslintrc.js | 3 years ago | |
| .gitignore | 3 years ago | |
| .npmrc | 6 years ago | |
| .prettierrc | 5 years ago | |
| .vercelignore | 3 years ago | |
| LICENSE | 3 years ago | |
| README.md | 2 years ago | |
| SECURITY.md | 3 years ago | |
| next.config.js | 3 years ago | |
| package.json | 3 years ago | |
| release.js | 6 years ago | |
| vercel.json | 3 years ago | |
| yarn.lock | 2 years ago | |
README.md
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.
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/<gist_id_goes_here>) - 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:
- Login using the "Sign in/Sign up" button
- Edit as you normally would โ your snippet will get saved automatically
- 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:
- Visit carbon.now.sh
- Click your browser's settings menu
- Click "Install Carbon..."
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 withshift-cmd-A - VS Code
carbon-now-sh- Open up your current VS Code file in Carbon with commandcarbon - 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 functionCarbonNowSh() - Emacs
carbon-now-sh- Open up the selection in your current Emacs using interactive functioncarbon-now-sh - Xcode
carbon-now-sh- Open up your current selection incarbon.now.sh - Xcode
nef- This Xcode extension enables you to export a code selection as a Carbon snippet in a single action
Tools
- CLI
carbon-now-cli- Open a file in Carbon or download it directly usingcarbon-now, featuring an interactive mode, selective highlighting and more - CodeExpander - A smart GitHub gist client with the TextExpander features
nef- Export multiple Carbon code snippets fromXcode Playground.@carbonshbot- A Telegram chatbot wich takes in a code snippet or gist URL and generates an Carbon image- R
carbonate- Iteratively manipulate image aesthetics inRand either open in Carbon or download directly. - Carbon for Slack - Use Carbon directly in Slack. Just invoke the
/carboncommand.
Citations
- "CS 101 - An Introduction to Computational Thinking" - a computer science textbook by Sarbo Roy.
Authors
Carbon is a project by:
- Mike Fix (@mfix22)
- Brian Dennis (@briandennis)
- Jake Dexheimer (@jakedex)
License
Contribute & Support
Pull requests are welcome! Please see our contributing guidelines for more details.
Sponsors & Backers
Thanks To
โฒ Vercel for sponsoring Carbon's hosting.
All Contributors
Thanks goes out to all these wonderful people (emoji key):
