Markdown Önizleme

Markdown Nedir?

Markdown, John Gruber tarafından 2004 yılında oluşturulan hafif bir işaretleme dilidir. Yıldız işareti, diyez ve tire gibi düz metin biçimlendirme sembollerini kullanarak başlık, kalın, italik, liste, bağlantı ve kod bloğu gibi yapıları ifade eder. Bir Markdown önizleyici bu düz metni biçimlendirilmiş HTML'ye dönüştürerek belgenin yayımlanmadan önce nasıl görüneceğini gösterir. Özgün Markdown belirtimi Gruber'ın Daring Fireball belgelerinde tanımlanmış olup format o tarihten bu yana CommonMark olarak resmileştirilmiştir.

Markdown, geliştirici belgeleri, README dosyaları, statik site oluşturucular (Jekyll, Hugo, Astro), wikiler ve bilgi tabanları için standart yazım formatı haline gelmiştir. GitHub, GitLab, Bitbucket, Stack Overflow, Reddit ve Notion Markdown'ı doğrudan destekler. Kaynak dosyaları düz metin olduğundan Markdown dosyalarını Git ile sürüm denetimi altında tutmak, dallar arasında fark almak ve çakışmayan bölümlerde birleştirmek son derece kolaydır.

Bir Markdown önizleme aracı girdinizi ayrıştırarak gerçek zamanlı olarak HTML'ye dönüştürür. Bu sayede bir dosyayı kaydetmeden veya bir sayfa yayımlamadan önce biçimlendirme hatalarını, bozuk bağlantıları ve beklenmedik iç içe geçmeleri fark edebilirsiniz. Bu önizleyici tamamen tarayıcınızda çalışır; sunucuya gidiş-dönüş yoktur, dolayısıyla özel veya hassas belgeler üzerinde içeriği ağ üzerinden göndermeden çalışabilirsiniz.

Neden Çevrimiçi Markdown Önizleyici Kullanmalısınız?

Önizleme olmadan düz bir düzenleyicide Markdown yazmak, çıktıyı tahmin etmeye çalışmak demektir. Canlı önizleyici bu geri bildirim döngüsünü anında kapatır.

Markdown Önizleme Kullanım Senaryoları

Markdown Söz Dizimi Başvuru Tablosu

Aşağıdaki tablo yaygın Markdown söz dizimini işlenmiş sonucuyla ve karşılık gelen HTML etiketiyle eşleştirir. Bu, hemen her Markdown ayrıştırıcısının desteklediği CommonMark temelini kapsar.

Markdown Türleri Karşılaştırması

Farklı platformlar özgün Markdown belirtimine ek özellikler ekler. Hangi türü hedeflediğinizi bilmek, başka bir işleyicide sessizce başarısız olan söz diziminden kaçınmanıza yardımcı olur.

Kod Örnekleri: Markdown'ı Programatik Olarak İşleme

Bir tarayıcı aracı yerine uygulama içinde Markdown işlemeniz gerektiğinde aşağıdaki kitaplıklardan birini kullanın. Her örnek bir Markdown dizesini HTML dizesine dönüştürür.

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>

Sıkça Sorulan Sorular