Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tiavina-mika committed Jun 21, 2024
1 parent f73997e commit 4b7d335
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tiptap-parser

<p align="left">
<p align="left">
HTML parser for <a href="https://www.npmjs.com/package/mui-tiptap-editor">Tiptap editor</a> build on the of <a href="https://www.npmjs.com/package/html-react-parser">html-react-parser</a> with code syntax highlighting.
</p>

Expand All @@ -10,25 +10,6 @@
[![Language](https://img.shields.io/badge/language-TypeScript-blue.svg?style=flat-square)](https://www.typescriptlang.org)
<!-- [END BADGES] -->

## Table of Contents

<details>

- [tiptap-parser](#tiptap-parser)
- [Table of Contents](#table-of-contents)
- [Use case](#use-case)
- [Demo](#demo)
- [Installation](#installation)
- [Get started](#get-started)
- [Simple usage](#simple-usage)
- [Content with code](#content-with-code)
- [Customization](#customization)
- [Props](#props)
- [Types](#types)
- [Contributing](#contributing)

</details>

## Use case
Tiptap editor is a text editor used mainly for blogging, and therefore in the back office.
<br />The problem is that if it's just to display the content (for example in a Next.js website), it is overkill to install <a href="https://tiptap.dev/">Tiptap</a> or <a href="https://www.npmjs.com/package/mui-tiptap-editor">mui-tiptap editor</a> (and the whole MUI library).
Expand Down Expand Up @@ -105,6 +86,7 @@ const html = `<p><h1>Hello there</h1></p>`;
|language|`string`|javascript| language of the code. [see the list](https://github.com/wooorm/lowlight?tab=readme-ov-file#data)

## Types

|props |type | Default value | Description |
|----------------|-------------------------------|-----------------------------|-----------------------------|
|codeClassName|`string`|empty| class name of code element
Expand Down

0 comments on commit 4b7d335

Please sign in to comment.