`, `
`, `
` tags:**\n\n```ts\n// Default behavior - limits to 3 consecutive newlines\nconst html = `
'.repeat(10)}
'.repeat(10)}something`;\n\n// Default (max 3 newlines)\nNodeHtmlMarkdown.translate(html);\n// Output: **text** \\n \\n \\n_something_\n\n// Custom (max 10 newlines)\nNodeHtmlMarkdown.translate(html, { maxConsecutiveNewlines: 10 });\n// Output: **text** \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n_something_\n```\n\n**When to adjust this setting:**\n\n- **Decrease** (e.g., `maxConsecutiveNewlines: 1`) for more compact output\n- **Increase** (e.g., `maxConsecutiveNewlines: 10`) when you need to preserve spacing from the source HTML\n- **Keep default** (`3`) for balanced, readable Markdown output\n\n## Custom Translators\n\nCustom translators are an advanced option to allow handling certain elements a specific way.\n\nThese can be modified via the `NodeHtmlMarkdown#translators` property, or added during creation.\n\n__For detail on how to use them see__:\n\n- [translator.ts](https://github.com/crosstype/node-html-markdown/blob/master/src/translator.ts) - Documentation for `TranslatorConfig`\n- [config.ts](https://github.com/crosstype/node-html-markdown/blob/master/src/config.ts) - Translators in `defaultTranslators`\n\nThe `NodeHtmlMarkdown#codeBlockTranslators` property is a collection of translators which handles elements within a `
`, etc. are surrounded by blank lines in the output.\n\n**Example:**\n\n```ts\nconst html = `
Hello
World
!
`;\nconst markdown = NodeHtmlMarkdown.translate(html);\nconsole.log(markdown);\n// Output:\n// Hello\n//\n// World\n//\n// !\n```\n\nThis is the expected behavior and produces valid, readable Markdown. If you need tighter spacing, consider using line breaks instead of paragraphs.\n\n### Line Breaks vs Paragraphs\n\n- **Paragraphs** (``) create blank lines between content (standard Markdown behavior)\n- **Line breaks** (`
`) create single line breaks with two trailing spaces (Markdown line break syntax)\n\n**Example:**\n\n```ts\n// Using line breaks\nconst html = `
Line 1
Line 2
Line 3
` tags:**\n\n```ts\n// Default behavior - limits to 3 consecutive newlines\nconst html = `
a
${''.repeat(10)}
b
`;\nconst markdown = NodeHtmlMarkdown.translate(html);\n// Result has maximum 3 consecutive line breaks\n\n// Allow more consecutive newlines\nconst markdown2 = NodeHtmlMarkdown.translate(html, {\n maxConsecutiveNewlines: 10\n});\n// Result preserves all 10 line breaks\n```\n\n**Example with inline elements:**\n\n```ts\nconst html = `text${''.repeat(10)}something`;\n\n// Default (max 3 newlines)\nNodeHtmlMarkdown.translate(html);\n// Output: **text** \\n \\n \\n_something_\n\n// Custom (max 10 newlines)\nNodeHtmlMarkdown.translate(html, { maxConsecutiveNewlines: 10 });\n// Output: **text** \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n_something_\n```\n\n**When to adjust this setting:**\n\n- **Decrease** (e.g., `maxConsecutiveNewlines: 1`) for more compact output\n- **Increase** (e.g., `maxConsecutiveNewlines: 10`) when you need to preserve spacing from the source HTML\n- **Keep default** (`3`) for balanced, readable Markdown output\n\n## Custom Translators\n\nCustom translators are an advanced option to allow handling certain elements a specific way.\n\nThese can be modified via the `NodeHtmlMarkdown#translators` property, or added during creation.\n\n__For detail on how to use them see__:\n\n- [translator.ts](https://github.com/crosstype/node-html-markdown/blob/master/src/translator.ts) - Documentation for `TranslatorConfig`\n- [config.ts](https://github.com/crosstype/node-html-markdown/blob/master/src/config.ts) - Translators in `defaultTranslators`\n\nThe `NodeHtmlMarkdown#codeBlockTranslators` property is a collection of translators which handles elements within a `
` block.\n\n## Further improvements\n\nBeing a performance-centric library, we're always interested in further improvements. \nThere are several probable routes by which we could gain substantial performance increases over the current model. \n\nSuch methods include:\n\n- Writing a custom parser\n- Integrating an async worker-thread based model for multi-threading\n- Fully replacing any remaining regex\n \nThese would be fun to implement; however, for the time being, the present library is fast enough for my purposes. That\nsaid, I welcome discussion and any PR toward the effort of further improving performance, and I may ultimately do more\nwork in that capacity in the future!\n\n## Help Wanted!\n\nLooking to contribute? Check out our [help wanted] list for a good place to start!\n\n\n[help wanted]: https://github.com/crosstype/node-html-markdown/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22\n","readmeFilename":"README.md"}