Skip to content

A text marking & annotation engine for presenting source code on the web.

License

Notifications You must be signed in to change notification settings

birjj/expressive-code

 
 

Repository files navigation

Expressive Code

Expressive Code is an engine for presenting source code on the web, aiming to make your code easy to understand and visually stunning.

On top of accurate syntax highlighting powered by the same engine as VS Code, Expressive Code allows you to annotate code blocks using text markers, diff highlighting, code editor & terminal window frames, and more.

All annotations are based on a powerful plugin architecture that allows you to extend the functionality of Expressive Code with your own custom annotations.

Expressive Code doesn't depend on any client-side framework, is built with performance in mind and designed to be as lightweight as possible.

No matter if you’re writing a blog, guide, or a full documentation website, Expressive Code will help you make your code examples stand out.

Packages

Expressive Code is split into multiple packages, allowing you to include only the functionality you need for your site. Click on any of the packages below to learn more about them:

Main packages

  • expressive-code NPM version - The main package that provides convenient access to the Expressive Code engine and all default plugins.
  • remark-expressive-code NPM version - A remark plugin that processes all code blocks in markdown and MDX files with Expressive Code.
  • astro-expressive-code NPM version - An Astro integration to automatically render code blocks in any markdown / MDX content on your site with Expressive Code.

Internal packages

Installation, Configuration & Usage

You will most likely want to install one of our high-level integrations, depending on your site's setup.

Please have a look at the documentation of those packages for more information:

Contributing

We welcome all contributions! Please read our contributing guide to learn about our development process and how to propose bugfixes and improvements.

About

A text marking & annotation engine for presenting source code on the web.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • Other 0.7%