mirror of https://github.com/sgoudham/carbon.git
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.
119 lines
17 KiB
Markdown
119 lines
17 KiB
Markdown
<p align="center"><img width=100% src="https://user-images.githubusercontent.com/10369094/31211729-591d059c-a950-11e7-86af-fa5ea3d7dbac.png"></p>
|
|
|
|
<!--[](https://github.com/dawnlabs/carbon/blob/readme-badges/package.json)-->
|
|
|
|
[](#contributors)
|
|
[](https://github.com/prettier/prettier)
|
|
[](http://makeapullrequest.com)
|
|
[](https://github.com/dawnlabs/carbon/blob/master/LICENSE)
|
|
[](https://greenkeeper.io/)
|
|
[](https://spectrum.chat/carbon-now)
|
|
<br></br>
|
|
[](https://deploy.now.sh/?repo=https://github.com/dawnlabs/carbon&env=TWITTER_CONSUMER_KEY&env=TWITTER_CONSUMER_SECRET&env=TWITTER_ACCESS_TOKEN_KEY&env=TWITTER_ACCESS_TOKEN_SECRET&env=LOGS_SECRET_PREFIX)
|
|
|
|
##### 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)
|
|
|
|
## Introduction
|
|
|
|
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.
|
|
|
|
Visit [carbon.now.sh](https://carbon.now.sh) or read [our post](https://dawnlabs.io/case-studies/carbon/) 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
|
|
|
|
<p align="center"><img width=100% src="https://user-images.githubusercontent.com/10369094/30791512-cb001438-a167-11e7-952b-f0f0e5c4499e.png"></p>
|
|
|
|
## 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 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.
|
|
|
|
## 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`
|
|
|
|
##### CLIs
|
|
|
|
- [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
|
|
|
|
##### Libraries
|
|
|
|
- [R `carbonate`](https://yonicd.github.io/carbonate/) - Iteratively manipulate image aesthetics in `R` and either open in Carbon or download directly.
|
|
|
|
##### Textbooks
|
|
|
|
- ["CS 101 - An Introduction to Computational Thinking"](https://itunes.apple.com/us/book/id1435714196) - a computer science textbook by Sarbo Roy.
|
|
|
|
## Contribute
|
|
|
|
PRs welcome! Please see our [CONTRIBUTING.md](https://github.com/dawnlabs/carbon/blob/master/.github/CONTRIBUTING.md) for more details.
|
|
|
|
## Thanks To
|
|
|
|
[ ▲ ZEIT ](https://zeit.co/) for sponsoring Carbon's hosting.
|
|
|
|
## Authors
|
|
|
|
Carbon is a project by <a href="http://dawnlabs.io/"><img width=8% src="https://cloud.githubusercontent.com/assets/10369094/25406306/dacebd4c-29cb-11e7-8e1c-468687cde495.png"></a>
|
|
|
|
- Mike Fix ([@mfix22](https://github.com/mfix22))
|
|
- 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 -->
|
|
| [<img src="https://avatars0.githubusercontent.com/u/10078572?v=4" width="100px;"/><br /><sub><b>briandennis</b></sub>](https://github.com/briandennis)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=briandennis "Code") [📖](https://github.com/dawnlabs/carbon/commits?author=briandennis "Documentation") [🚇](#infra-briandennis "Infrastructure (Hosting, Build-Tools, etc)") [👀](#review-briandennis "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/8397708?v=4" width="100px;"/><br /><sub><b>mfix22</b></sub>](https://github.com/mfix22)<br />[💬](#question-mfix22 "Answering Questions") [💻](https://github.com/dawnlabs/carbon/commits?author=mfix22 "Code") [🤔](#ideas-mfix22 "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/10369094?v=4" width="100px;"/><br /><sub><b>jakedex</b></sub>](https://github.com/jakedex)<br />[💬](#question-jakedex "Answering Questions") [💻](https://github.com/dawnlabs/carbon/commits?author=jakedex "Code") [🎨](#design-jakedex "Design") [📹](#video-jakedex "Videos") | [<img src="https://avatars1.githubusercontent.com/u/10191084?v=4" width="100px;"/><br /><sub><b>andrewda</b></sub>](https://github.com/andrewda)<br />[💬](#question-andrewda "Answering Questions") [💻](https://github.com/dawnlabs/carbon/commits?author=andrewda "Code") [🐛](https://github.com/dawnlabs/carbon/issues?q=author%3Aandrewda "Bug reports") [👀](#review-andrewda "Reviewed Pull Requests") | [<img src="https://avatars2.githubusercontent.com/u/14703164?v=4" width="100px;"/><br /><sub><b>yeskunall</b></sub>](https://github.com/yeskunall)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=yeskunall "Code") [📖](https://github.com/dawnlabs/carbon/commits?author=yeskunall "Documentation") [🔧](#tool-yeskunall "Tools") [🐛](https://github.com/dawnlabs/carbon/issues?q=author%3Ayeskunall "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/2652676?v=4" width="100px;"/><br /><sub><b>stoshfabricius</b></sub>](https://github.com/stoshfabricius)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=stoshfabricius "Code") | [<img src="https://avatars1.githubusercontent.com/u/11639896?v=4" width="100px;"/><br /><sub><b>jkling38</b></sub>](https://github.com/jkling38)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=jkling38 "Documentation") |
|
|
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
|
| [<img src="https://avatars1.githubusercontent.com/u/225946?v=4" width="100px;"/><br /><sub><b>otobrglez</b></sub>](https://github.com/otobrglez)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=otobrglez "Code") | [<img src="https://avatars3.githubusercontent.com/u/11488612?v=4" width="100px;"/><br /><sub><b>darahak</b></sub>](https://github.com/darahak)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=darahak "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/246651?v=4" width="100px;"/><br /><sub><b>dom96</b></sub>](https://github.com/dom96)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=dom96 "Code") | [<img src="https://avatars3.githubusercontent.com/u/784056?v=4" width="100px;"/><br /><sub><b>elrumordelaluz</b></sub>](https://github.com/elrumordelaluz)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=elrumordelaluz "Code") | [<img src="https://avatars2.githubusercontent.com/u/21217?v=4" width="100px;"/><br /><sub><b>cjb</b></sub>](https://github.com/cjb)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=cjb "Code") | [<img src="https://avatars1.githubusercontent.com/u/5427083?v=4" width="100px;"/><br /><sub><b>Krzysztof-Cieslak</b></sub>](https://github.com/Krzysztof-Cieslak)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=Krzysztof-Cieslak "Code") | [<img src="https://avatars0.githubusercontent.com/u/2369851?v=4" width="100px;"/><br /><sub><b>fernahh</b></sub>](https://github.com/fernahh)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=fernahh "Documentation") |
|
|
| [<img src="https://avatars1.githubusercontent.com/u/10941033?v=4" width="100px;"/><br /><sub><b>g3r4n</b></sub>](https://github.com/g3r4n)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=g3r4n "Code") | [<img src="https://avatars0.githubusercontent.com/u/55830?v=4" width="100px;"/><br /><sub><b>Mat Gadd</b></sub>](http://drarok.com/)<br />[🐛](https://github.com/dawnlabs/carbon/issues?q=author%3ADrarok "Bug reports") [💻](https://github.com/dawnlabs/carbon/commits?author=Drarok "Code") | [<img src="https://avatars1.githubusercontent.com/u/11805775?v=4" width="100px;"/><br /><sub><b>Brad Davies</b></sub>](https://bradlab.co.uk)<br />[🐛](https://github.com/dawnlabs/carbon/issues?q=author%3Avarbrad "Bug reports") [💻](https://github.com/dawnlabs/carbon/commits?author=varbrad "Code") | [<img src="https://avatars1.githubusercontent.com/u/9087886?v=4" width="100px;"/><br /><sub><b>Rafael Câmara</b></sub>](http://www.rafaelcamaram.com/)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=rafaelcamaram "Code") | [<img src="https://avatars1.githubusercontent.com/u/2212006?v=4" width="100px;"/><br /><sub><b>Gleb Bahmutov</b></sub>](https://glebbahmutov.com/)<br />[⚠️](https://github.com/dawnlabs/carbon/commits?author=bahmutov "Tests") [🔧](#tool-bahmutov "Tools") | [<img src="https://avatars2.githubusercontent.com/u/10677789?v=4" width="100px;"/><br /><sub><b>Iván Munguía</b></sub>](https://ivan-munguia.netlify.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=warborn "Code") | [<img src="https://avatars1.githubusercontent.com/u/2755722?v=4" width="100px;"/><br /><sub><b>Dillon Mulroy</b></sub>](https://dillonmulroy.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=dmmulroy "Code") |
|
|
| [<img src="https://avatars2.githubusercontent.com/u/253398?v=4" width="100px;"/><br /><sub><b>Nihad Abbasov</b></sub>](https://github.com/NARKOZ)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=NARKOZ "Code") | [<img src="https://avatars1.githubusercontent.com/u/7328625?v=4" width="100px;"/><br /><sub><b>Hugo Torzuoli</b></sub>](https://torzuolih.github.io)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=TorzuoliH "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/1906977?v=4" width="100px;"/><br /><sub><b>Bruno C. Couto</b></sub>](https://github.com/imbrn)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=imbrn "Code") | [<img src="https://avatars2.githubusercontent.com/u/13263073?v=4" width="100px;"/><br /><sub><b>Mark Molnar</b></sub>](https://github.com/molnarmark)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=molnarmark "Code") | [<img src="https://avatars1.githubusercontent.com/u/1459450?v=4" width="100px;"/><br /><sub><b>Takahiko Inayama</b></sub>](https://www.behance.net/tetra2000)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=TETRA2000 "Code") | [<img src="https://avatars1.githubusercontent.com/u/14319020?v=4" width="100px;"/><br /><sub><b>François Martin</b></sub>](https://github.com/martinfrancois)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=martinfrancois "Code") | [<img src="https://avatars3.githubusercontent.com/u/3630346?v=4" width="100px;"/><br /><sub><b>Raphael Amorim</b></sub>](http://raphamorim.io)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=raphamorim "Code") |
|
|
| [<img src="https://avatars0.githubusercontent.com/u/27292?v=4" width="100px;"/><br /><sub><b>Camron Flanders</b></sub>](http://camronflanders.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=camflan "Code") | [<img src="https://avatars0.githubusercontent.com/u/6516758?v=4" width="100px;"/><br /><sub><b>Eric Adamski</b></sub>](https://ericadamski.github.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=ericadamski "Code") | [<img src="https://avatars0.githubusercontent.com/u/4671080?v=4" width="100px;"/><br /><sub><b>Winner Crespo</b></sub>](http://winnercrespo.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=wistcc "Code") [🎨](#design-wistcc "Design") | [<img src="https://avatars3.githubusercontent.com/u/672237?v=4" width="100px;"/><br /><sub><b>Milos</b></sub>](http://twitter.com/mixn)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=mixn "Code") [🔧](#tool-mixn "Tools") [📖](https://github.com/dawnlabs/carbon/commits?author=mixn "Documentation") [🌍](#translation-mixn "Translation") | [<img src="https://avatars1.githubusercontent.com/u/29014463?v=4" width="100px;"/><br /><sub><b>Yashu Mittal</b></sub>](https://mittalyashu.now.sh/)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=mittalyashu "Code") | [<img src="https://avatars0.githubusercontent.com/u/22792183?v=4" width="100px;"/><br /><sub><b>Rachel M. Carmena</b></sub>](https://twitter.com/bberrycarmen)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=rachelcarmena "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/19369949?v=4" width="100px;"/><br /><sub><b>Miguel Salazar</b></sub>](https://www.linkedin.com/in/miguel-salazar-823b07a1/)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=ucdstudent95618 "Documentation") [🌍](#translation-ucdstudent95618 "Translation") |
|
|
| [<img src="https://avatars3.githubusercontent.com/u/19145803?v=4" width="100px;"/><br /><sub><b>Vyom Jain</b></sub>](https://www.linkedin.com/in/vyom-jain-233a28139)<br />[📖](https://github.com/dawnlabs/carbon/commits?author=vvyomjjain "Documentation") [🌍](#translation-vvyomjjain "Translation") | [<img src="https://avatars0.githubusercontent.com/u/5010047?v=4" width="100px;"/><br /><sub><b>racaljk</b></sub>](http://www.cnblogs.com/racaljk/)<br />[🌍](#translation-racaljk "Translation") | [<img src="https://avatars3.githubusercontent.com/u/3892149?v=4" width="100px;"/><br /><sub><b>Sean</b></sub>](https://lastblocklabs.com)<br />[💻](https://github.com/dawnlabs/carbon/commits?author=raboid "Code") | [<img src="https://avatars0.githubusercontent.com/u/19255077?v=4" width="100px;"/><br /><sub><b>Izabela Borges</b></sub>](http://izabelacborges.com/)<br />[🌍](#translation-izabelacborges "Translation") | [<img src="https://avatars2.githubusercontent.com/u/18573510?v=4" width="100px;"/><br /><sub><b>Shinil M S</b></sub>](https://ghuser.io/shinilms)<br />[🌍](#translation-shinilms "Translation") | [<img src="https://avatars1.githubusercontent.com/u/10579633?v=4" width="100px;"/><br /><sub><b>Berke Atac</b></sub>](https://github.com/berkeatac)<br />[🌍](#translation-berkeatac "Translation") | [<img src="https://avatars3.githubusercontent.com/u/18481078?v=4" width="100px;"/><br /><sub><b>LEE YONGJUN</b></sub>](https://wooooooak.github.io/)<br />[🌍](#translation-wooooooak "Translation") |
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|