n8n-nodes-turndown-html-to-markdown - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/nodes/MdTurndown/MdTurndown.node.js

 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -32,3 +9,3 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 const turndown_1 = __importDefault(require("turndown"));
-const marked = __importStar(require("marked"));
+const marked_1 = __importDefault(require("marked"));
 class MdTurndown {
@@ -132,5 +109,5 @@ constructor() {
 async function markdownToHtml(input) {
-    const html = marked.parse(input);
+    const html = marked_1.default.parse(input);
     return html;
 }
 //# sourceMappingURL=MdTurndown.node.js.map

dist/package.json

 {
     "name": "n8n-nodes-turndown-html-to-markdown",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "description": "Node to use in n8n that allows you to convert HTML to MarkDown using one of the most famous JS libraries that perform this conversion to Turndown | PT-BR: Nó para usar em n8n que permite converter HTML para MarkDown usando uma das bibliotecas JS mais famosas que realizam essa conversão, Turndown",
@@ -5,0 +5,0 @@ "keywords": [

package.json

 {
   "name": "n8n-nodes-turndown-html-to-markdown",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Node to use in n8n that allows you to convert HTML to MarkDown using one of the most famous JS libraries that perform this conversion to Turndown | PT-BR: Nó para usar em n8n que permite converter HTML para MarkDown usando uma das bibliotecas JS mais famosas que realizam essa conversão, Turndown",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -1,47 +0,57 @@
-![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
+# n8n-nodes-turndown-html-to-markdown
 
-# n8n-nodes-starter
+<p align="center">
+    <img src="https://i.imgur.com/OoBh1ro.png" alt="Functions MarkDown TurnDown"/>
+    <br/>
+    <a href="https://www.npmjs.com/package/n8n-nodes-turndown-html-to-markdown"><img src="https://img.shields.io/npm/v/n8n-nodes-turndown-html-to-markdown.svg?logo=npm" alt="NPM version"/></a>
+    <br/>
+</p>
 
-This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies.
+> **EN-US:**
+>  
+> This is an n8n community node. It lets you use turndown-html-to-markdown in your n8n workflows.
+> 
+> Node to use in n8n that allows you to convert HTML to MarkDown using one of the most famous JS libraries that perform this conversion to Turndown
 
-To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
+> **PT-BR:**
+>  
+> Este é um nó da comunidade n8n. Ele permite que você use turndown-html-to-markdown em seus fluxos de trabalho n8n.
+> 
+> Nó para usar em n8n que permite converter HTML para MarkDown usando uma das bibliotecas JS mais famosas que realizam essa conversão, Turndown
 
-## Prerequisites
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
 
-You need the following installed on your development machine:
+* [Demos](#demos)  
+* [Installation](#installation)  
+* [Operations](#operations)  
+* [Compatibility](#compatibility)  
+* [Resources](#resources)  
 
-* [git](https://git-scm.com/downloads)
-* Node.js and npm. Minimum version Node 16. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
-* Install n8n with:
-	```
-	npm install n8n -g
-	```
-* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
+## Demos
+### Example of how Turndown styled HTML in MarkDown:
+![Example of how Turndown styled HTML in MarkDown](https://i.imgur.com/CD9R8mc.png)
+### MarkDown TurnDown working in n8n, converting HTML to Markdown, with line wrapping and standard visual style from the TurnDown library:
+![MarkDown TurnDown working in n8n, converting HTML to Markdown, with line wrapping and standard visual style from the TurnDown library](https://i.imgur.com/93yZGt3.png)
 
 
-## Using this starter
+## Installation
 
-These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/).
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/#install-a-community-node) in the n8n community nodes documentation.
 
-1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository.
-2. Clone your new repo:
-    ```
-    git clone https://github.com/<your organization>/<your-repo-name>.git
-    ```
-3. Run `npm i` to install dependencies.
-4. Open the project in your editor.
-5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes.
-6. Update the `package.json` to match your details.
-7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
-8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
-9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
-10. Update the LICENSE file to use your details.
-11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
+## Operations
 
-## More information
+_List the operations supported by your node._
+- HTML > Markdown
+- Markdown > HTML
 
-Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
+## Compatibility
 
-## License
+_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._
+- n8n v0.221.2 or higher
 
-[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* This package uses the [Turndown](https://github.com/mixmark-io/turndown) library to convert HTML to Markdown.
+* This package uses the [Marked](https://github.com/markedjs/marked) library to be able to convert Markdown to HTML.
+

No alert changes

Improved metrics

Number of lines in readme file

58

increased by20.83%

Worsened metrics

Total package byte prevSize

43581

decreased by-2.85%

Lines of code

117

decreased by-16.43%

No dependency changes