@deckdeckgo/highlight-code/README.md

A Web Component to highlight your code

[![npm][npm-badge]][npm-badge-url]
[![license][npm-license]][npm-license-url]

[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/highlight-code
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/highlight-code
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/highlight-code
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/main/webcomponents/highlight-code/LICENSE

# DeckDeckGo - Highlight Code

This component is the code highlighter of [DeckDeckGo].

It is developed with [Stencil](https://stenciljs.com) and use [Prism.js](https://prismjs.com) from [Lea Verou](http://lea.verou.me) and [James DiGioia](https://twitter.com/jamesdigioia) for the highlighting itself.

Furthermore, the inspiration for the design of the cards comes from the amazing [carbon](https://carbon.now.sh), a tool to create and share beautiful images of your source code.

## Table of contents

- [Getting Started](#getting-started)
- [License](#license)

## Getting Started

To get started with this Web Component, have a look to its [documentation](https://docs.deckdeckgo.com/?path=/story/components-highlight-code--highlight-code).

## License

MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com)

[deckdeckgo]: https://deckdeckgo.com