HTML to Markdown

Wat is HTML naar Markdown-conversie?

HTML naar Markdown-conversie zet HTML-opmaak om naar Markdown, een lichtgewicht platte-tekstopmaaksyntaxis die John Gruber in 2004 ontwikkelde. Markdown is ontworpen om leesbaar te zijn zonder rendering. Waar HTML openings- en sluitingstags vereist zoals <strong> en <a href="">, gebruikt Markdown verkorte tekens: **vet**, [links](url) en # koppen. Het converteren van HTML naar Markdown levert bestanden op die gemakkelijker te lezen, bewerken en versiebeheren zijn dan ruwe HTML.

Het conversieproces wijst HTML-elementen toe aan hun Markdown-equivalenten. Een <h2> wordt ##, een <ul><li> wordt - item, en een <a>-tag wordt [tekst](url). Sommige HTML-elementen hebben geen direct Markdown-equivalent, zoals <div>, <span> of aangepaste data-attributen. Converters verwijderen deze tags doorgaans of laten ze als ruwe HTML door, afhankelijk van de configuratie.

Markdown is de standaard schrijfindeling geworden voor ontwikkelaarsdocumentatie (GitHub, GitLab, Bitbucket), statische sitegeneratoren (Hugo, Jekyll, Astro), notitie-apps (Obsidian, Notion) en technische blogs. Bestaande HTML-inhoud omzetten naar Markdown is een gebruikelijke stap bij het migreren van websites, importeren van CMS-inhoud of archiveren van webpagina's in een draagbaar formaat. Anders dan HTML produceren Markdown-bestanden overzichtelijke diffs in versiebeheer, waardoor code-review van documentatiewijzigingen praktisch is.

Waarom een HTML naar Markdown-converter gebruiken?

HTML handmatig herschrijven als Markdown is traag en foutgevoelig, zeker voor pagina's met geneste lijsten, tabellen of tientallen links. Een geautomatiseerde converter verwerkt de structuurkoppeling direct en consistent.

Toepassingen van HTML naar Markdown

HTML naar Markdown-elementreferentie

De tabel hieronder toont hoe veelgebruikte HTML-elementen worden gekoppeld aan hun Markdown-equivalenten. Deze koppeling volgt de GitHub-Flavored Markdown (GFM)-conventies, die de CommonMark-specificatie uitbreiden met tabellen, doorhaling en takenlijsten. Elementen die hier niet worden vermeld (zoals <div>, <form> of aangepaste webcomponenten) hebben geen Markdown-equivalent en worden ofwel verwijderd of als ruwe HTML doorgelaten.

Markdown-varianten: GFM vs CommonMark vs origineel

Niet alle Markdown is hetzelfde. Het uitvoerformaat is belangrijk omdat verschillende platforms Markdown anders verwerken. De drie meest voorkomende varianten zijn GitHub-Flavored Markdown (GFM), CommonMark en Grubers originele Markdown.

Codevoorbeelden

Werkende voorbeelden in JavaScript (Turndown), Python (markdownify en html2text), Go en Pandoc op de opdrachtregel.

import TurndownService from 'turndown'

const turndown = new TurndownService({ headingStyle: 'atx' })
const html = '<h1>Title</h1><p>A <strong>bold</strong> paragraph.</p>'
const md = turndown.turndown(html)
console.log(md)
// → "# Title\n\nA **bold** paragraph."

from markdownify import markdownify

html = '<h2>Section</h2><ul><li>First</li><li>Second</li></ul>'
md = markdownify(html, heading_style='ATX')
print(md)
# → "## Section\n\n- First\n- Second"

import html2text

converter = html2text.HTML2Text()
converter.body_width = 0  # disable line wrapping

html = '<p>Visit <a href="https://example.com">Example</a> for details.</p>'
md = converter.handle(html)
print(md)
# → "Visit [Example](https://example.com) for details."

package main

import (
	"fmt"
	md "github.com/JohannesKaufmann/html-to-markdown"
)

func main() {
	converter := md.NewConverter("", true, nil)
	html := `<h3>Go Example</h3><p>Code: <code>fmt.Println()</code></p>`
	markdown, _ := converter.ConvertString(html)
	fmt.Println(markdown)
	// → "### Go Example\n\nCode: `fmt.Println()`"
}

# Convert an HTML file to Markdown
pandoc input.html -f html -t markdown -o output.md

# Pipe HTML from stdin
echo '<p>Hello <em>world</em></p>' | pandoc -f html -t markdown
# → Hello *world*

# Use GitHub-Flavored Markdown output
pandoc input.html -f html -t gfm -o output.md

Veelgestelde vragen