tiptap-parser - npm Package Compare versions

Comparing version 0.0.3 to 0.0.5

dist/esm/index.d.ts

@@ -1,1 +0,2 @@
-export { default as TiptapParser, type TiptapProps, type ClassNamesProps, } from './Parse.js';
+export { default as TiptapParser, type TiptapProps, type ClassNamesProps } from './TiptapParser.js';
+export { type HTMLReactParserOptions } from 'html-react-parser';

dist/esm/index.js

@@ -1,1 +0,1 @@
-export { default as TiptapParser, } from './Parse.js';
+export { default as TiptapParser } from './TiptapParser.js';

dist/index.d.ts

@@ -1,1 +0,2 @@
-export { default as TiptapParser, type TiptapProps, type ClassNamesProps, } from './Parse.js';
+export { default as TiptapParser, type TiptapProps, type ClassNamesProps } from './TiptapParser.js';
+export { type HTMLReactParserOptions } from 'html-react-parser';

dist/index.js

@@ -7,3 +7,3 @@ "use strict";
 exports.TiptapParser = void 0;
-var Parse_1 = require("./Parse");
-Object.defineProperty(exports, "TiptapParser", { enumerable: true, get: function () { return __importDefault(Parse_1).default; } });
+var TiptapParser_1 = require("./TiptapParser");
+Object.defineProperty(exports, "TiptapParser", { enumerable: true, get: function () { return __importDefault(TiptapParser_1).default; } });

package.json

 {
   "name": "tiptap-parser",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "HTML parser to React component built on the top of html-react-parser with code syntax highlighting",
@@ -9,3 +9,3 @@ "keywords": [
     "rich text editor",
-    "react text editor",
+    "react",
     "wysiwyg",
@@ -15,4 +15,5 @@ "quill",
     "slate",
+    "lowlight",
+    "highlight",
     "html string to react",
-    "html-react-parser",
     "code editor"
@@ -19,0 +20,0 @@ ],

README.md

@@ -5,3 +5,3 @@ # tiptap-parser
 
-<b>tiptap-parser</b>: HTML parser for Tiptap <a href="https://www.npmjs.com/package/html-react-parser">html-react-parser</a> with code syntax highlighting.
+<b>tiptap-parser</b>: 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.
 
@@ -15,3 +15,5 @@ </p>
 
+- [Motivation](#motivation)
 - [Installation](#installation)
+- [Demo](#demo)
 
@@ -28,7 +30,12 @@ - [Get started](#get-started)
 
+## Motivation
+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).
+<br />The purpose of this library is precisely to display the contents of mui-tiptap-editor which is an html saved as text.
+If you are using a dev oriented blog like Medium, this library is for you.
+
 ## Demo
-
 Try it yourself in this **[CodeSandbox live demo](https://codesandbox.io/p/github/tiavina-mika/tiptap-parser-demo)**
 
-<img alt="Screenshot" src="https://github.com/tiavina-mika/mui-tiptap-editor/blob/main/screenshots/screenshot.png" />
+<img alt="Screenshot" src="https://github.com/tiavina-mika/tiptap-parser/blob/main/screenshots/screenshot.png" />
 
@@ -70,11 +77,7 @@ ## Installation
 ```tsx
-const html = `<><h1>Hello there</h1><code>console.log("Log something here")</code></>`;
+const html = `<><h1>Hello there</h1><pre><code>console.log("Log something here")</code></pre></>`;
 
-function App() {
-  return (
-    <TiptapParser language="typescript">
-      {html}
-    </TiptapParser>
-  );
-}
+<TiptapParser language="typescript">
+  {html}
+</TiptapParser>
 ```
@@ -88,2 +91,3 @@
 <TiptapParser
+  containerClassName="bg-gray-100"
   classNames={{
@@ -125,5 +129,7 @@ codeClassName: 'p-6',
 |imageClassName|`string`|empty| class name of image element
+|other props|`HTMLReactParserOptions`|empty| [all html-react-parser props](https://www.npmjs.com/package/html-react-parser)
 
+
 ## Contributing
 
 Get started [here](https://github.com/tiavina-mika/tiptap-parser/blob/main/CONTRIBUTING.md).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22082

9.58%

Number of package files

13

8.33%

Lines of code

322

10.27%

Number of lines in readme file

130

4.84%

Worsened metrics

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes