react-code-block

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

react-code-block

★ 76 Open GitHub ↗

🧩 Set of unstyled UI components to build powerful code blocks in React.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <br />
  <br />
  <h1>React Code Block 🧩</h1>
  <p>
    Set of unstyled UI components to build powerful code blocks in React.
  </p>
  <p>
    <a href="https://www.npmjs.com/package/react-code-block"><img src="https://badgen.net/npm/v/react-code-block" /></a>
    <img src="https://badgen.net/bundlephobia/minzip/react-code-block?label=gzipped%20size" />
    <img src="https://badgen.net/npm/types/react-code-block" />
    <img src="https://badgen.net/bundlephobia/tree-shaking/react-code-block" />
    <img src="https://badgen.net/npm/license/react-code-block" />
  </p>
  <br />
  <br />
  <br />
  <br />
</div>

![React Code Block banner](https://react-code-block.netlify.app/banner.jpg)

### Features

- ✅ **Unstyled**
- ✅ **Syntax highlighting**
- ✅ **Line numbers**
- ✅ **Line highlighting**
- ✅ **Word highlighting**
- ✅ **Theming**
- ✅ **Shiki support**

### Getting started

```bash
npm i react-code-block prism-react-renderer
```

[**Continue with basic example here →**](https://react-code-block.netlify.app/usage#basic-example)

### Documentation

You can find the complete documentation at [**react-code-block.netlify.app**](https://react-code-block.netlify.app)

### Why?

**Let's face it, building code blocks is hard!** There are various libraries out there that handle syntax highlighting, but then you realize that you need more than just
syntax highlighting. If you are writing a technical blog or documentation, chances are you need features like line numbers, line highlighting, word highlighting and so on.
Most of the syntax highlighting libraries don't come with this out-of-the-box, so you have to spend time implementing all this by yourself. Or if they do come with these
features, it's incredibly hard to extend and style them according to the way you want it to be.

React Code Block solves all these problems by only providing you with the core functionality without any of the styling. You can compose the primitive components from this
library to build any kind of code block you need.

### How does it work?

React Code Block uses an existing syntax highlighting library under the hood for syntax highlighting. On top of this, it adds
additional features like line numbers, line highlighting, etc. which can be styled through the primitive components this package exposes.
Currently supported syntax highlighted libraries:
- [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer)
- [shiki](https://shiki.matsu.io/)

### License

React Code Block is [MIT Licensed](https://github.com/blenderskool/react-code-block/blob/master/LICENSE).

react-code-block

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README