Article Title
This is a bold and italic paragraph.
- First item
- Second item
const x = 42;Text
') console.log(result) ``` -------------------------------- ### Markdown Fenced Code Block Source: https://github.com/mixmark-io/turndown/blob/master/test/index.html A Markdown fenced code block. Used for multi-line code examples. ```markdown ~~~ ``` ```markdown Code ``` ```markdown ~~~ ``` ```markdown ``` ``` ```markdown Code ``` ```markdown ``` ``` ```markdown ``` ```markdown Code ``` ```markdown ``` -------------------------------- ### Filter Elements with a Function Source: https://github.com/mixmark-io/turndown/blob/master/README.md Shows how to use a function for the 'filter' property in a Turndown rule to conditionally select nodes. This example selects 'A' elements with an 'href' attribute when the 'linkStyle' option is 'inlined'. ```javascript filter: function (node, options) { return ( options.linkStyle === 'inlined' && node.nodeName === 'A' && node.getAttribute('href') ) } ``` -------------------------------- ### Instantiate TurndownService with Options Source: https://github.com/mixmark-io/turndown/blob/master/README.md Create a new TurndownService instance and pass configuration options during initialization. ```javascript var turndownService = new TurndownService({ option: 'value' }) ``` -------------------------------- ### Using Plugins Source: https://github.com/mixmark-io/turndown/blob/master/README.md Demonstrates how to use plugins with the TurndownService instance. Plugins can be used individually or as an array. The `use` method returns the `TurndownService` instance for chaining. ```APIDOC ## `use(plugin|array)` ### Description Use a plugin, or an array of plugins. The `use` method returns the `TurndownService` instance for chaining. ### Method `use` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```javascript // Import plugins from turndown-plugin-gfm var turndownPluginGfm = require('turndown-plugin-gfm') var gfm = turndownPluginGfm.gfm var tables = turndownPluginGfm.tables var strikethrough = turndownPluginGfm.strikethrough // Use the gfm plugin turndownService.use(gfm) // Use the table and strikethrough plugins only turndownService.use([tables, strikethrough]) ``` ### Response #### Success Response (200) Returns the `TurndownService` instance for chaining. #### Response Example (Instance of TurndownService) ``` -------------------------------- ### Use Turndown Plugins Source: https://github.com/mixmark-io/turndown/blob/master/README.md Demonstrates how to import and use plugins from 'turndown-plugin-gfm' with the TurndownService instance. Supports using single plugins or an array of multiple plugins. ```javascript var turndownPluginGfm = require('turndown-plugin-gfm') var gfm = turndownPluginGfm.gfm var tables = turndownPluginGfm.tables var strikethrough = turndownPluginGfm.strikethrough // Use the gfm plugin turndownService.use(gfm) // Use the table and strikethrough plugins only turndownService.use([tables, strikethrough]) ``` -------------------------------- ### Basic Usage Source: https://github.com/mixmark-io/turndown/blob/master/README.md Demonstrates how to initialize Turndown and convert simple HTML strings or DOM nodes to Markdown. ```APIDOC ## Usage ### Basic Conversion ```js // For Node.js var TurndownService = require('turndown') var turndownService = new TurndownService() var markdown = turndownService.turndown('| Name | Value |
|---|---|
| Alpha | 1 |
Hello worldWorld
Hello worldWorld
| Name | Value |
|---|---|
| Alpha | 1 |
This is a bold and italic paragraph.
const x = 42;This is a bold and italic paragraph.
const x = 42;Hello
World
') console.log(markdown) // Output: Hello // // World // Remove elements using a function filter turndownService.remove(function (node) { return node.classList && node.classList.contains('no-export') }) var html = 'Visible content
This is deleted text
This is deleted text
Hello world universe
` elements is never passed to the `escape` method.
```
--------------------------------
### Remove HTML elements with Turndown
Source: https://context7.com/mixmark-io/turndown/llms.txt
Use the `remove` method to specify elements that should be completely removed from the output, including their content. This is useful for elements like scripts or styles. You can provide an array of tag names or a function filter.
```javascript
var TurndownService = require('turndown')
var turndownService = new TurndownService()
// Remove specific elements entirely
turndownService.remove(['script', 'style', 'noscript'])
var markdown = turndownService.turndown(
'Hello
World
'
)
console.log(markdown)
// Output: Hello
//
// World
```
```javascript
// Remove elements using a function filter
turndownService.remove(function (node) {
return node.classList && node.classList.contains('no-export')
})
var html = 'Visible content
Hidden content'
var result = turndownService.turndown(html)
console.log(result)
// Output: Visible content
```
```javascript
// Remove elements with specific attributes
turndownService.remove(function (node) {
return node.getAttribute('data-ignore') === 'true'
})
```
--------------------------------
### Markdown Numbered List Item
Source: https://github.com/mixmark-io/turndown/blob/master/test/index.html
A Markdown numbered list item. Used for ordered lists.
```markdown
1. Chapter One
```
```markdown
1. Chapter One
```
```markdown
1. First
```
```markdown
1. First
```