# HTML to Markdown (`web.harvester/html-to-markdown`) Actor

Convert HTML to clean Markdown. Supports GFM tables, code blocks, and custom rules. Perfect for content migration and documentation.

- **URL**: https://apify.com/web.harvester/html-to-markdown.md
- **Developed by:** [Web Harvester](https://apify.com/web.harvester) (community)
- **Categories:** Developer tools, Automation, Other
- **Stats:** 3 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$3.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## HTML to Markdown

> 🔄 Convert HTML to clean Markdown. Supports GFM tables, code blocks, and custom formatting. Perfect for content migration.

[![Apify Actor](https://img.shields.io/badge/Apify-Actor-blue)](https://apify.com)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

### 🎯 What This Actor Does

Convert HTML to Markdown:

- **GFM Tables** - HTML tables → Markdown tables
- **Code Blocks** - Fenced or indented
- **Headings** - ATX (#) or Setext (underlined)
- **Lists** - Customizable bullet markers
- **Clean Output** - Readable Markdown

### 🚀 Use Cases

| Use Case | Description |
|----------|-------------|
| **Content Migration** | Move HTML to Markdown-based CMS |
| **Documentation** | Convert HTML docs to MD |
| **Web Scraping** | Extract content as Markdown |
| **Blog Import** | Import HTML posts |
| **Archive** | Store web content as MD |
| **Git Wikis** | Convert HTML wikis |

### 📥 Input Examples

#### Basic Conversion

```json
{
    "html": "<h1>Title</h1><p>Content</p>",
    "headingStyle": "atx"
}
````

#### From URL

```json
{
    "htmlUrl": "https://example.com/page.html",
    "gfmTables": true
}
```

#### Custom Formatting

```json
{
    "html": "<ul><li>Item</li></ul>",
    "bulletListMarker": "*",
    "codeBlockStyle": "fenced"
}
```

### ⚙️ Configuration

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `html` | string | - | HTML content |
| `htmlUrl` | string | - | URL to HTML page |
| `headingStyle` | string | `atx` | atx (#) or setext (underlined) |
| `codeBlockStyle` | string | `fenced` | fenced (\`\`\`) or indented |
| `bulletListMarker` | string | `-` | -, \*, or + |
| `gfmTables` | boolean | `true` | Convert tables to GFM |
| `keepImages` | boolean | `true` | Convert img tags |
| `keepLinks` | boolean | `true` | Convert a tags |

### 📤 Output

```json
{
    "inputLength": 200,
    "outputLength": 150,
    "headingStyle": "atx",
    "markdown": "# Title\n\nContent here...",
    "markdownUrl": "https://api.apify.com/v2/..."
}
```

### 📝 Conversion Examples

#### Headers

```html
<h1>Title</h1>  →  # Title
<h2>Subtitle</h2>  →  ## Subtitle
```

#### Text Formatting

```html
<strong>bold</strong>  →  **bold**
<em>italic</em>  →  *italic*
<code>code</code>  →  `code`
```

#### Lists

```html
<ul><li>Item</li></ul>  →  - Item
<ol><li>First</li></ol>  →  1. First
```

### 💰 Cost Estimation

| Size | Approx. Time | Compute Units |
|------|--------------|---------------|
| 10 KB | ~1 second | ~0.001 |
| 100 KB | ~2 seconds | ~0.003 |

### 🔧 Technical Details

- **Language:** TypeScript / Node.js 22
- **Library:** Turndown 7.x
- **Memory:** 128MB-256MB

### 📄 License

MIT License - see [LICENSE](LICENSE) for details.

***

### 🏪 Apify Store Listing

<details>
<summary>Click to copy store details</summary>

**Actor name:**

```
HTML to Markdown
```

**Description:** *(296/300 chars)*

```
Convert HTML to clean Markdown using Turndown. Supports GFM tables, code blocks, custom heading styles. Fetch from URL or paste HTML. Configurable bullet markers and formatting. Perfect for content migration, documentation conversion, and web scraping output.
```

**SEO Actor name:**

```
HTML to Markdown Converter - Turndown
```

**SEO Description:** *(193/200 chars)*

```
Convert HTML to Markdown. GFM tables, code blocks, custom formatting. Fetch from URL. For content migration, documentation, web scraping.
```

**Icon:** Use `assets/icon.svg` in this folder

</details>

***

**Keywords:** html to markdown, html to md, turndown, html converter, markdown converter, content migration, gfm

# Actor input Schema

## `html` (type: `string`):

HTML to convert to Markdown

## `htmlUrl` (type: `string`):

URL to an HTML page to convert

## `headingStyle` (type: `string`):

How to format headings

## `codeBlockStyle` (type: `string`):

How to format code blocks

## `bulletListMarker` (type: `string`):

Character for unordered lists

## `gfmTables` (type: `boolean`):

Convert HTML tables to GitHub-style markdown tables

## `keepImages` (type: `boolean`):

Convert <img> tags to ![alt](src)

## `keepLinks` (type: `boolean`):

Convert <a> tags to [text](href)

## Actor input object example

```json
{
  "html": "<h1>Hello World</h1>\n<p>This is <strong>bold</strong> and <em>italic</em> text.</p>\n<ul>\n  <li>Item 1</li>\n  <li>Item 2</li>\n</ul>",
  "headingStyle": "atx",
  "codeBlockStyle": "fenced",
  "bulletListMarker": "-",
  "gfmTables": true,
  "keepImages": true,
  "keepLinks": true
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "html": `<h1>Hello World</h1>
<p>This is <strong>bold</strong> and <em>italic</em> text.</p>
<ul>
  <li>Item 1</li>
  <li>Item 2</li>
</ul>`
};

// Run the Actor and wait for it to finish
const run = await client.actor("web.harvester/html-to-markdown").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "html": """<h1>Hello World</h1>
<p>This is <strong>bold</strong> and <em>italic</em> text.</p>
<ul>
  <li>Item 1</li>
  <li>Item 2</li>
</ul>""" }

# Run the Actor and wait for it to finish
run = client.actor("web.harvester/html-to-markdown").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "html": "<h1>Hello World</h1>\\n<p>This is <strong>bold</strong> and <em>italic</em> text.</p>\\n<ul>\\n  <li>Item 1</li>\\n  <li>Item 2</li>\\n</ul>"
}' |
apify call web.harvester/html-to-markdown --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=web.harvester/html-to-markdown",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "HTML to Markdown",
        "description": "Convert HTML to clean Markdown. Supports GFM tables, code blocks, and custom rules. Perfect for content migration and documentation.",
        "version": "0.0",
        "x-build-id": "tMQgHNnV4IP4hSJLU"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/web.harvester~html-to-markdown/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-web.harvester-html-to-markdown",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/web.harvester~html-to-markdown/runs": {
            "post": {
                "operationId": "runs-sync-web.harvester-html-to-markdown",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/web.harvester~html-to-markdown/run-sync": {
            "post": {
                "operationId": "run-sync-web.harvester-html-to-markdown",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "html": {
                        "title": "HTML Content",
                        "type": "string",
                        "description": "HTML to convert to Markdown"
                    },
                    "htmlUrl": {
                        "title": "Or HTML URL",
                        "type": "string",
                        "description": "URL to an HTML page to convert"
                    },
                    "headingStyle": {
                        "title": "Heading Style",
                        "enum": [
                            "atx",
                            "setext"
                        ],
                        "type": "string",
                        "description": "How to format headings",
                        "default": "atx"
                    },
                    "codeBlockStyle": {
                        "title": "Code Block Style",
                        "enum": [
                            "fenced",
                            "indented"
                        ],
                        "type": "string",
                        "description": "How to format code blocks",
                        "default": "fenced"
                    },
                    "bulletListMarker": {
                        "title": "Bullet List Marker",
                        "enum": [
                            "-",
                            "*",
                            "+"
                        ],
                        "type": "string",
                        "description": "Character for unordered lists",
                        "default": "-"
                    },
                    "gfmTables": {
                        "title": "GFM Tables",
                        "type": "boolean",
                        "description": "Convert HTML tables to GitHub-style markdown tables",
                        "default": true
                    },
                    "keepImages": {
                        "title": "Keep Images",
                        "type": "boolean",
                        "description": "Convert <img> tags to ![alt](src)",
                        "default": true
                    },
                    "keepLinks": {
                        "title": "Keep Links",
                        "type": "boolean",
                        "description": "Convert <a> tags to [text](href)",
                        "default": true
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```