You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
carbon/README.md

136 lines
24 KiB
Markdown

6 years ago
<p align="center">
<img width="100%" src="https://user-images.githubusercontent.com/10369094/31211729-591d059c-a950-11e7-86af-fa5ea3d7dbac.png" />
</p>
6 years ago
<p align="center">
<a href="#contributors">
<img src="https://img.shields.io/badge/all_contributors-53-orange.svg?style=flat-square" alt="All Contributors" />
</a>
<a href="https://github.com/prettier/prettier">
<img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="styled with prettier" />
</a>
<a href="https://github.com/dawnlabs/carbon/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/dawnlabs/carbon.svg" alt="MIT License" />
</a>
<a href="https://greenkeeper.io/">
<img src="https://badges.greenkeeper.io/dawnlabs/carbon.svg" alt="Greenkeeper badge" />
</a>
<a href="https://spectrum.chat/carbon-now">
<img src="https://withspectrum.github.io/badge/badge.svg" alt="Join the community on Spectrum" />
</a>
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fdawnlabs%2Fcarbon?ref=badge_shield">
<img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdawnlabs%2Fcarbon.svg?type=shield" alt="FOSSA Status" /> </a>
</p>
7 years ago
<br></br>
6 years ago
[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/dawnlabs/carbon)
##### Translations
- [Español](/docs/README.es.md)
- [हिंदी](/docs/README.hi.md)
- [Deutsch](/docs/README.de.md)
- [简体中文](/docs/README.cn.zh.md)
- [Português](/docs/README.br.pt.md)
- [മലയാളം](/docs/README.ml.md)
- [Türkçe](/docs/README.tr.md)
- [한국어](/docs/README.kr.md)
- [தமிழ்](/docs/README.ta.md)
- [Français](/docs/README.fr.md)
- [日本語](/docs/README.ja.md)
7 years ago
## Introduction
8 years ago
You know [all](https://twitter.com/dan_abramov/status/890191815567175680) [of](https://twitter.com/reactjs/status/890511993261654017) [those code](https://twitter.com/notquiteleo/status/873483329345028096) [screenshots](https://twitter.com/zeithq/status/805779711154647040) 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.
7 years ago
Visit [carbon.now.sh](https://carbon.now.sh) or read [our post](https://dawnlabs.io/case-studies/carbon/) to learn more about the project.
7 years ago
## Features
- **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
6 years ago
- **Import from GitHub gist**. Simply append a GitHub gist id to the url
7 years ago
7 years ago
## Example
6 years ago
<p><img width=80% src="https://user-images.githubusercontent.com/10369094/30791512-cb001438-a167-11e7-952b-f0f0e5c4499e.png"></p>
7 years ago
7 years ago
## Usage
7 years ago
#### Import
7 years ago
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`)
7 years ago
- Paste your code directly
7 years ago
#### Customization
7 years ago
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.
7 years ago
#### Export/Sharing
7 years ago
After you've customized your image you can either Tweet a link to the image, or save it directly.
7 years ago
If you use the &apos;Tweet&apos; button, Carbon will automatically make your image accessible. However, if you want to manually tweet your carbon image, please check out [how to make your Twitter images accessible](https://help.twitter.com/en/using-twitter/picture-descriptions).
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](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details) below the image.
#### Installing Carbon for Desktop
If you are using Google Chrome, or another browser that supports Progressive Web Apps, you can install Carbon for use offline by clicking your browser's settings menu and then "Install Carbon..."
7 years ago
## Community
7 years ago
Check out these projects our awesome community has created:
6 years ago
##### 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
7 years ago
- [Atom `carbon-now-sh`](https://atom.io/packages/carbon-now-sh) - Open up your current Atom file in Carbon with `shift-cmd-A`
7 years ago
- [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`
6 years ago
##### 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
6 years ago
- [Carbonize](https://itunes.apple.com/us/app/carbonize/id1451177988) - A macOS wrapper with extended native features
- [CodeExpander](https://codeexpander.com) - A smart GitHub gist client with the TextExpander features
6 years ago
##### Libraries
- [R `carbonate`](https://yonicd.github.io/carbonate/) - Iteratively manipulate image aesthetics in `R` and either open in Carbon or download directly.
7 years ago
6 years ago
##### Textbooks
6 years ago
- ["CS 101 - An Introduction to Computational Thinking"](https://itunes.apple.com/us/book/id1435714196) - a computer science textbook by Sarbo Roy.
6 years ago
7 years ago
## Contribute
7 years ago
PRs welcome! Please see our [CONTRIBUTING.md](https://github.com/dawnlabs/carbon/blob/master/.github/CONTRIBUTING.md) for more details.
7 years ago
## Thanks To
7 years ago
[ ▲ ZEIT ](https://zeit.co/) for sponsoring Carbon's hosting.
7 years ago
## Authors
6 years ago
Carbon is a project by:
6 years ago
- Mike Fix ([@mfix22](https://twitter.com/fixitup2))
7 years ago
- Brian Dennis ([@briandennis](https://github.com/briandennis))
- Jake Dexheimer ([@jakedex](https://github.com/jakedex))
## Contributors
Thanks goes out to all these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table><tr><td align="center"><a href="https://github.com/briandennis"><img src="https://avatars0.githubusercontent.com/u/10078572?v=4" width="100px;" alt="briandennis"/><br /><sub><b>briandennis</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=briandennis" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/commits?author=briandennis" title="Documentation">📖</a> <a href="#infra-briandennis" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#review-briandennis" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/mfix22"><img src="https://avatars0.githubusercontent.com/u/8397708?v=4" width="100px;" alt="mfix22"/><br /><sub><b>mfix22</b></sub></a><br /><a href="#question-mfix22" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=mfix22" title="Code">💻</a> <a href="#ideas-mfix22" title="Ideas, Planning, & Feedback">🤔</a></td><td align="center"><a href="https://github.com/jakedex"><img src="https://avatars1.githubusercontent.com/u/10369094?v=4" width="100px;" alt="jakedex"/><br /><sub><b>jakedex</b></sub></a><br /><a href="#question-jakedex" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=jakedex" title="Code">💻</a> <a href="#design-jakedex" title="Design">🎨</a> <a href="#video-jakedex" title="Videos">📹</a></td><td align="center"><a href="https://github.com/andrewda"><img src="https://avatars1.githubusercontent.com/u/10191084?v=4" width="100px;" alt="andrewda"/><br /><sub><b>andrewda</b></sub></a><br /><a href="#question-andrewda" title="Answering Questions">💬</a> <a href="https://github.com/dawnlabs/carbon/commits?author=andrewda" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/issues?q=author%3Aandrewda" title="Bug reports">🐛</a> <a href="#review-andrewda" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/yeskunall"><img src="https://avatars2.githubusercontent.com/u/14703164?v=4" width="100px;" alt="yeskunall"/><br /><sub><b>yeskunall</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=yeskunall" title="Code">💻</a> <a href="https://github.com/dawnlabs/carbon/commits?author=yeskunall" title="Documentation">📖</a> <a href="#tool-yeskunall" title="Tools">🔧</a> <a href="https://github.com/dawnlabs/carbon/issues?q=author%3Ayeskunall" title="Bug reports">🐛</a></td><td align="center"><a href="https://github.com/stoshfabricius"><img src="https://avatars1.githubusercontent.com/u/2652676?v=4" width="100px;" alt="stoshfabricius"/><br /><sub><b>stoshfabricius</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=stoshfabricius" title="Code">💻</a></td><td align="center"><a href="https://github.com/jkling38"><img src="https://avatars1.githubusercontent.com/u/11639896?v=4" width="100px;" alt="jkling38"/><br /><sub><b>jkling38</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=jkling38" title="Documentation">📖</a></td></tr><tr><td align="center"><a href="https://github.com/otobrglez"><img src="https://avatars1.githubusercontent.com/u/225946?v=4" width="100px;" alt="otobrglez"/><br /><sub><b>otobrglez</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=otobrglez" title="Code">💻</a></td><td align="center"><a href="https://github.com/darahak"><img src="https://avatars3.githubusercontent.com/u/11488612?v=4" width="100px;" alt="darahak"/><br /><sub><b>darahak</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=darahak" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/dom96"><img src="https://avatars0.githubusercontent.com/u/246651?v=4" width="100px;" alt="dom96"/><br /><sub><b>dom96</b></sub></a><br /><a href="https://github.com/dawnlabs/carbon/commits?author=dom96" title="Code">💻</a></td><td align="center"><a href="https://github.com/elrumordelaluz"><img src="https://avatars3.githubuserco
<!-- ALL-CONTRIBUTORS-LIST:END -->