HTML to Markdown

Vad är HTML till Markdown-konvertering?

HTML till Markdown-konvertering omvandlar HTML-uppmärkning till Markdown, ett lättviktigt syntaxformat för vanlig text som skapades av John Gruber år 2004. Markdown designades för att vara läsbart utan rendering. Där HTML kräver öppnings- och stängningstaggar som <strong> och <a href="">, använder Markdown kortkommandon: **fetstil**, [länkar](url) och # rubriker. Att konvertera HTML till Markdown producerar filer som är enklare att läsa, redigera och versionshantera än rå HTML.

Konverteringsprocessen mappar HTML-element till deras Markdown-motsvarigheter. Ett <h2> blir ##, ett <ul><li> blir - post, och ett <a>-tagg blir [text](url). Vissa HTML-element saknar direkt Markdown-motsvarighet, till exempel <div>, <span> eller anpassade dataattribut. Konverterare tar vanligtvis bort dessa taggar eller skickar dem vidare som rå HTML, beroende på konfiguration.

Markdown har blivit standardformatet för utvecklardokumentation (GitHub, GitLab, Bitbucket), statiska webbplatsgeneratorer (Hugo, Jekyll, Astro), anteckningsappar (Obsidian, Notion) och tekniska bloggar. Att konvertera befintligt HTML-innehåll till Markdown är ett vanligt steg vid migrering av webbplatser, import av CMS-innehåll eller arkivering av webbsidor i ett portabelt format. Till skillnad från HTML producerar Markdown-filer rena diff:ar i versionshantering, vilket gör kodgranskning av dokumentationsändringar praktiskt.

Varför använda en HTML till Markdown-konverterare?

Att manuellt skriva om HTML som Markdown är långsamt och felbenäget, särskilt för sidor med nästlade listor, tabeller eller dussintals länkar. En automatiserad konverterare hanterar strukturmappningen direkt och konsekvent.

Användningsfall för HTML till Markdown

HTML till Markdown-elementreferens

Tabellen nedan visar hur vanliga HTML-element mappas till sina Markdown-motsvarigheter. Mappningen följer GitHub-Flavored Markdown (GFM)-konventioner, som utökar CommonMark-specifikationen med tabeller, genomstrykning och uppgiftslistor. Element som inte listas här (till exempel <div>, <form> eller anpassade webbkomponenter) saknar Markdown-motsvarighet och tas antingen bort eller skickas vidare som rå HTML.

Markdown-varianter: GFM vs CommonMark vs original

Inte all Markdown är densamma. Utdataformatet spelar roll eftersom olika plattformar tolkar Markdown på olika sätt. De tre vanligaste varianterna är GitHub-Flavored Markdown (GFM), CommonMark och Grubers ursprungliga Markdown.

Kodexempel

Praktiska exempel i JavaScript (Turndown), Python (markdownify och html2text), Go och Pandoc på kommandoraden.

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

Vanliga frågor