carbon README

The project's README from github.com/carbon-app/carbon. As one markdown file: README.md.

maintained with Ranger All Contributors MIT License FOSSA Status



Translations
Español हिंदी Deutsch 简体中文 Português
മലയാളം Türkçe 한국어 தமிழ் Français
日本語 Svenska Polski Nederlands 正體中文
Indonesia Українська Italiano עברית Русский
العربية বাংলা فارسی 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.

Carbon example

Features

Usage

Import

There are a few different ways to import code into Carbon:

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:

  1. Login using the "Sign in/Sign up" button
  2. Edit as you normally would — your snippet will get saved automatically
  3. 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:

  1. Visit carbon.now.sh
  2. Click your browser's settings menu
  3. Click "Install Carbon..."

Community

Check out these projects our awesome community has created:

Editor Plugins
Tools
Citations

Authors

Carbon is a project by:

License

FOSSA Status




Contribute & Support

Pull requests are welcome! Please see our contributing guidelines for more details.

Sponsors & Backers

Fossa

Powered by Vercel

Thanks To

▲ Vercel for sponsoring Carbon's hosting.

All 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

💻

Bruno C. Couto

💻

Mark Molnar

💻

carbon (carbon-app/carbon)

Searching Database…

36.1K ·GitHub
这是什么?Carbon 是一个网页应用,可以把源代码变成漂亮、便于分享的图片,很适合在 Twitter、Slack 或博客上发布代码片段。
这是桌面应用,还是在浏览器里使用的?它主要是一个网站(carbon.now.sh),使用 Next.js 构建。不过 Chrome 等支持 PWA 的浏览器可以将它“安装”到电脑上,让它像桌面应用一样离线使用。
我要怎样把代码放进 Carbon?你可以把代码文件拖到编辑器里,也可以直接输入或粘贴代码,还可以在网址后面附加 GitHub gist ID(例如 carbon.now.sh/ )。
我需要注册才能生成图片吗?不需要,无需账号就能创建并导出图片;只有当你想保存代码片段,并通过可分享的链接保持其可编辑状态时,才需要登录。
离线使用在所有浏览器中都可以吗?离线安装只适用于 Chrome 或其他支持渐进式网页应用(PWA)的浏览器,并非所有浏览器默认都支持。
Carbon 可以导出哪些图片格式?Carbon 可以把代码片段导出为 PNG 或 SVG 格式,也可以直接把渲染好的图片复制到剪贴板。
Carbon 有编辑器集成吗?社区已经为 VS Code、Vim/Neovim、Emacs、Sublime Text、Atom、IntelliJ IDEA 和 Xcode 开发了插件,还有一个名为 carbon-now-cli 的独立命令行工具。
我能把 Carbon 代码片段嵌入自己的网站吗?可以。任何已保存的代码片段或 gist 都可以通过 carbon.now.sh/embed/:id 嵌入,并提供现成的 iframe 代码片段,或适用于 Medium 等平台的编码后链接。
What are similar projects?Lepton, remark, VibeOffice, ascii, magicui, whirl, cult-ui, apexcharts.js
Creator
carbon-app
Size
20.6 MB
Stars
36.1K
Age
9y
Commits · 90 Days