Back

Markdown Önizleme

Markdown, düz metin söz dizimi kullanarak biçimlendirilmiş metin oluşturmaya yarayan hafif bir işaretleme dilidir. Belgelendirme, README dosyaları ve not alma için popüler olan Markdown, görüntüleme için HTML'ye dönüştürülür. Bu araç, canlı görüntüleme ile Markdown'ı önizler, belge yapısını (başlıklar, bağlantılar, görseller) çıkarır ve HTML'ye dönüştürebilir.

Spesifikasyonlar

Yaygin Kullanim Alanlari

  • Commit öncesi README.md dosyalarını önizleme
  • Belge biçimlendirmesini gözden geçirme
  • Doğrulama için belgeden tüm bağlantıları çıkarma
  • Gömme için Markdown'ı HTML'ye dönüştürme
  • Belge yapısını ve gezinmeyi analiz etme

Ozellikler

  • HTML görüntüleme ile canlı önizleme
  • Belge yapısını çıkarma (başlıkları içindekiler tablosu olarak)
  • Belgedeki tüm bağlantıları ve görselleri listeleme
  • Dil ipuçlarıyla kod bloklarını algılama ve görüntüleme
  • Ön bilgi (YAML meta verileri) ayrıştırma
  • Temiz HTML çıktısına dönüştürme
  • Kelime ve karakter sayısı istatistikleri

Ornekler

Özellikli README

Deneyin →

Başlıklar, listeler ve kod içeren tipik bir proje README'si.

# My Project

A brief description of what this project does.

## Installation

```bash
npm install my-project
```

## Features

- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework

## Links

- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)

Ipuclari

  • Başlıklar için # kullanın (# H1, ## H2, ### H3 vb.).
  • Kod blokları, isteğe bağlı dil tanımlayıcısıyla üçlü ters tırnak kullanır.
  • Bağlantılar [metin](url) söz dizimini; görseller ![alternatif metin](url) söz dizimini kullanır.
  • --- satırları arasındaki ön bilgi YAML meta verileri içerebilir.

Anlama Markdown Önizleme

Markdown, 2004 yılında John Gruber tarafından oluşturulan, düz metin olarak okunabilir olurken temiz bir şekilde HTML'ye dönüşecek şekilde tasarlanmış hafif bir işaretleme dilidir. Söz dizimi, biçimlendirmelerini görsel olarak çağrıştıran noktalama karakterleri kullanır: başlıklar için #, vurgu için *, listeler için - ve kod için ters tırnaklar. Markdown dosyaları görüntülenmeden bile kullanışlı kalır, bu yüzden format belgelendirme, README dosyaları ve teknik yazım alanında hakim konumdadır.

CommonMark spesifikasyonu (2014), orijinal Markdown'ın birçok belirsizliğini gidermiştir. CommonMark, uç durumların nasıl ele alınacağını kesin olarak tanımlar ve çoğu modern ayrıştırıcı bunu uygular. GitHub Flavored Markdown (GFM), CommonMark'ı tablolar, görev listeleri, üzeri çizili metin, otomatik bağlantılı URL'ler ve söz dizimi vurgulama ile çitlenmiş kod blokları ile genişletir.

GFM, README dosyaları, çekme isteği açıklamaları, sorun yorumları ve belgelendirme siteleri için fiili standarttır. Çoğu belgelendirme platformu (Notion, Docusaurus, MkDocs, GitBook) GFM'yi veya onun bir üst kümesini destekler.

Ön bilgi, Markdown dosyalarına yapılandırılmış meta veri eklemek için yaygın bir kuraldır. Dosyanın üst kısmında --- satırlarıyla sınırlandırılmış bir YAML bloğu, statik site oluşturucuların (Astro, Hugo, Jekyll, Next.js) gezinme ve sayfa düzenleri oluşturmak için kullandığı başlık, tarih, yazar ve etiketleri içerebilir.

Pratikte "Markdown" neredeyse her zaman CommonMark veya GFM anlamına gelir. Orijinal Markdown spesifikasyonu birçok uç durumu tanımsız bırakmış ve CommonMark bu belirsizlikleri katı bir spesifikasyonla çözmüştür. GFM, CommonMark'ı tablolar, görev listeleri, üzeri çizili metin ve otomatik bağlantılı URL'lerle genişletir. Bir Markdown ayrıştırıcısını veya görüntüleyicisini değerlendirirken CommonMark uyumluluğunu kontrol etmek, uç durumları ne kadar iyi ele aldığının güvenilir bir göstergesidir.

GFM'deki tablolar sütunları ayırmak için boru işaretleri (|) ve başlık ayırıcı satır için tire (-) kullanır. Sütun hizalaması ayırıcıdaki iki nokta üst üste ile kontrol edilir: :--- sola hizalı, :---: ortalı ve ---: sağa hizalıdır. Tablolar bir GFM uzantısıdır ve orijinal Markdown söz diziminin parçası değildir. Dosyanın en başında --- satırlarıyla sınırlandırılmış ön bilgi, statik site oluşturucuların başlık, tarih, düzen ve etiketler gibi sayfa meta verileri için kullandığı bir YAML meta veri bloğudur. GitHub, ön bilgiyi dosyanın üstünde bir tablo olarak görüntüler ancak tüm görüntüleyiciler bunu işlemez.

Çitlenmiş kod blokları, açılan ters tırnaklardan sonra isteğe bağlı bir dil tanımlayıcısı ile üçlü ters tırnak kullanır - örneğin, üç ters tırnaktan sonra "javascript" gelen bir satır, söz dizimi vurgulama ile bir JavaScript bloğu başlatır. Kullanılabilir dil tanımlayıcıları görüntüleme platformuna bağlıdır. Kodu dört boşluk girintileme de bir kod bloğu oluşturur ancak vurgulama için bir dil belirleme imkanı sunmaz.

← Tum araclara don