4ec73afe31
* Update README.md * make wording more terse * tweak |
5 years ago | |
|---|---|---|
| .github | 5 years ago | |
| components | 5 years ago | |
| cypress | 5 years ago | |
| docs | 5 years ago | |
| lib | 5 years ago | |
| packages/gatsby-remark-embed-carbon | 6 years ago | |
| pages | 5 years ago | |
| public | 5 years ago | |
| .all-contributorsrc | 5 years ago | |
| .eslintrc.js | 6 years ago | |
| .gitignore | 5 years ago | |
| .gitpod.yml | 5 years ago | |
| .nowignore | 6 years ago | |
| .npmrc | 6 years ago | |
| .prettierrc | 7 years ago | |
| LICENSE | 5 years ago | |
| README.md | 5 years ago | |
| cypress.json | 7 years ago | |
| next.config.js | 5 years ago | |
| now.json | 5 years ago | |
| package.json | 5 years ago | |
| release.js | 6 years ago | |
| yarn.lock | 5 years ago | |
README.md
Translations
| Español | हिंदी | Deutsch | 简体中文 | Português | മലയാളം | Türkçe |
| 한국어 | தமிழ் | Français | 日本語 | Svenska | 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.
Features
- Customization. Customize things like your image's syntax theme, window style, and more
- Share quickly. Save your image or a link with one click
- Import from GitHub gist. Simply append a GitHub gist id to the url
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 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.
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:
- Visiting https://carbon.now.sh
- Clicking your browser's settings menu
- Clicking "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 - Carbonize - A macOS wrapper with extended native features
- CodeExpander - A smart GitHub gist client with the TextExpander features
nef- Export multiple Carbon code snippets fromXcode Playground.
Libraries
- R
carbonate- Iteratively manipulate image aesthetics inRand either open in Carbon or download directly.
Textbooks
- "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
Does your company use Carbon? Consider sponsoring the project to fund new features, bug fixes, and more.
Backers
Love using Carbon? Consider supporting the project to fund new features and improvements
Thanks To
▲ ZEIT for sponsoring Carbon's hosting.
Contributors
All Contributors
Thanks goes out to all these wonderful people (emoji key):
