Markdown Preview

Vad är Markdown?

Markdown är ett lättviktigt märkspråk skapat av John Gruber år 2004. Det använder klartext-formateringssymboler som asterisker, brädgårdar och bindestreck för att ange struktur: rubriker, fetstil, kursiv, listor, länkar och kodblock. En Markdown-förhandsvisare renderar den klartexten till formaterad HTML så att du kan se exakt hur det färdiga dokumentet kommer att se ut innan du publicerar det. Den ursprungliga Markdown-specifikationen beskrivs i Grubers Daring Fireball-dokumentation, och formatet har sedan dess formaliserats som CommonMark.

Markdown har blivit standardformatet för utvecklardokumentation, README-filer, statiska webbplatsgeneratorer (Jekyll, Hugo, Astro), wikis och kunskapsbaser. GitHub, GitLab, Bitbucket, Stack Overflow, Reddit och Notion stöder alla Markdown inbyggt. Eftersom källan är klartext är Markdown-filer enkla att versionshantera med Git, jämföra mellan grenar och sammanfoga utan konflikter i icke-överlappande delar av en fil.

Ett Markdown-förhandsvisningsverktyg tolkar din inmatning och konverterar den till HTML i realtid. Det låter dig fånga formateringsfel, brutna länkar och oväntad nästning innan du commitar en fil eller publicerar en sida. Den här förhandsvisaren körs helt i din webbläsare utan serveranrop, så du kan arbeta med privat eller känslig dokumentation utan att skicka innehåll över nätverket.

Varför använda en online-Markdown-förhandsvisare?

Att skriva Markdown i en vanlig editor utan förhandsvisning innebär att du gissar på resultatet. En liveförhandsvisare stänger den återkopplingsslingan direkt.

Användningsområden för Markdown Preview

Markdown-syntaxreferens

Tabellen nedan kopplar vanlig Markdown-syntax till dess renderade resultat och motsvarande HTML-element. Detta täcker CommonMark-baslinjen som praktiskt taget alla Markdown-tolkare stöder.

Markdown-varianter jämförda

Olika plattformar utökar den ursprungliga Markdown-specifikationen med extra funktioner. Att veta vilken variant du riktar dig mot hjälper dig att undvika syntax som tyst misslyckas i en annan renderare.

Kodexempel: Rendera Markdown programmatiskt

När du behöver rendera Markdown inuti en applikation snarare än ett webbläsarverktyg, använd ett av dessa bibliotek. Varje exempel konverterar en Markdown-sträng till en HTML-sträng.

import { marked } from 'marked'

const md = '# Hello\n\nThis is **Markdown**.'
const html = marked(md)
// → "<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>\n"

// With options
marked.setOptions({ gfm: true, breaks: true })
const gfmHtml = marked('Line one\nLine two')
// → "<p>Line one<br>Line two</p>\n"

import markdown

md = '# Hello\n\nThis is **Markdown**.'
html = markdown.markdown(md)
# → '<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>'

# With extensions
html = markdown.markdown(md, extensions=['fenced_code', 'tables'])

# Convert a file
with open('README.md') as f:
    html = markdown.markdown(f.read(), extensions=['extra'])

package main

import (
	"bytes"
	"fmt"
	"github.com/yuin/goldmark"
)

func main() {
	source := []byte("# Hello\n\nThis is **Markdown**.")
	var buf bytes.Buffer
	if err := goldmark.Convert(source, &buf); err != nil {
		panic(err)
	}
	fmt.Println(buf.String())
	// → <h1>Hello</h1>
	// → <p>This is <strong>Markdown</strong>.</p>
}

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

# Convert with GitHub Flavored Markdown
pandoc README.md -f gfm -t html --standalone -o output.html

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

Vanliga frågor