Markdown önizleme

Markdown belgelerini önizle

Markdown belgelerini önizle0 karakter / 0 satır
Markdown kaynağı
Önizleme
Önizleme burada görünür

Araç rehberi

Markdown önizleme hakkında

Markdown Preview Markdown source değerini okunabilir preview haline render eder; headings, lists, links, blockquotes, tables ve code blocks kontrol edilir.

README, documentation snippet, issue veya blog draft göndermeden önce kullanılır.

Markdown Preview nasıl kullanılır

  1. Markdown source yapıştırın.
  2. GFM tables, fenced code blocks ve links için sample kullanın.
  3. Heading hierarchy, list indentation ve link rendering kontrol edin.

Ne zaman kullanılır

  • README code block language ve table alignment commit öncesi kontrol etmek.
  • GitHub issue veya release note posting öncesi preview etmek.
  • API documentation snippets içinde headings ve nested lists incelemek.

Markdown syntax ve formatting traps

Markdown hafiftir ama blank lines, indentation ve backtick sayısı rendering değiştirir. GitHub Flavored Markdown tables, task lists ve fenced code blocks ekler.

  • Headings # kullanır ve logical hierarchy izlemelidir.
  • Nested lists indentation bağlıdır; tabs ve spaces karışımı layout bozar.
  • Fenced code blocks triple backticks kullanır ve language name içerebilir.
  • Link metin açıklayıcı olmalı, sadece “click here” olmamalıdır.

Markdown önizleme hakkında sık sorulan sorular

GitHub Flavored Markdown destekler mi?
Tables, fenced code blocks ve task lists gibi common GFM features preview edilir, ama final rendering target platforma bağlıdır.
Nested list neden başarısız?
Genelde indentation veya blank lines kaynaklıdır. Child list items parenttan daha içeride olmalı ve marker style tutarlı kalmalıdır.
Content upload edilir mi?
Hayır. Markdown rendering tarayıcıda lokal çalışır ve wetool.site sunucusuna upload edilmez.

Markdown Preview ve publishing

Preview çoğu formatting issue yakalar, ama GitHub, npm, forums ve CMS farklı Markdown extensions ve sanitizers kullanabilir. Publish öncesi target platform üzerinde tekrar kontrol edin.

Markdown dialect karşılaştırması

Preview araç structure issues bulmaya yardım eder, fakat Markdown dialects platforms arasında değişir.

  • CommonMark headings, paragraphs, lists, blockquotes ve code blocks gibi baseline syntax kapsar.
  • GitHub Flavored Markdown tables, task lists, strikethrough ve autolinks gibi common extensions ekler.
  • Blogs, CMS ve documentation sites front matter, heading anchors, footnotes veya math formulas ekleyebilir.

Safe rendering ve publishing sınırları

Markdown preview final publishing environment değildir; HTML, images, external links ve platform filters için dikkat gerekir.

  • Untrusted Markdown değerini safe HTML gibi kullanmayın; target platforms genelde raw HTML sanitize eder.
  • External images ve links publishing sonrası istek sources, token parameters veya internal addresses açığa çıkarabilir.
  • README, npm docs veya CMS pages yayınlamadan önce target platform üzerinde final rendering kontrol edin.

İlgili araçlar