/codeimage

Create elegant screenshots of your source code. Built with SolidJS

Primary LanguageTypeScriptMIT LicenseMIT

CodeImage logo

Create elegant code screenshots of your source code.

Latest release Version Build workflow badge Issues Lint workflow badge Built with SolidJS Built with Vanilla Extract Code quality License

CodeImage showcase

Introduction

CodeImage is the newest tool to help developers to create beautiful screenshots of their code, providing several features to speed up the process to post in social media.

🚀 Features

✅ Customizable terminal window, editor and frame style
✅ 15+ custom themes for code editor
✅ Highlighting support for 10+ programming languages
✅ Tab name with customizable icons
Web share api support
✅ Keyboard shortcuts support
✅ Mobile view support
✅ Multi-language support
✅ Light and dark mode support

💻 Run locally

To run the project locally, you must have in your local machine pnpm >= 6.23.2 and node >= 14.x;

  1. Install dependencies
$ pnpm install
  1. Build core libraries
$ pnpm libs:build
  1. Run @codeimage/app
  • Development mode:
$ pnpm dev
  • Production mode (no reload, serve static files):
$ pnpm build:prod && pnpm serve --filter=@codeimage/app

🤖 Tech stack

CodeImage front-end app currently relies on these technologies:

Other libraries:

🌏 Contributions

⚠️ Read this before opening any PR!

When contributing, it's better to first discuss the change you wish to make via issue or discussion, or any other method with the owners of this repository before making a change.

Until the end of solid hackathon voting ends phase, pull request must target the next branch

See the CONTRIBUTING.md guide for more details.

License

MIT © Riccardo Perra