Markdown Preview

Markdown क्या है?

Markdown एक हल्की मार्कअप भाषा है जिसे John Gruber ने 2004 में बनाया था। यह structure दिखाने के लिए asterisk, hash और dash जैसे plain-text formatting symbols का उपयोग करती है: हेडिंग, बोल्ड, इटैलिक, सूचियाँ, लिंक और कोड ब्लॉक। एक Markdown प्रीव्यूअर उस सादे पाठ को स्वरूपित HTML में रूपांतरित करता है ताकि आप प्रकाशित करने से पहले देख सकें कि अंतिम दस्तावेज़ कैसा दिखेगा। मूल Markdown विनिर्देश Gruber के Daring Fireball दस्तावेज़ में वर्णित है, और इस प्रारूप को बाद में CommonMark के रूप में औपचारिक रूप दिया गया है।

Markdown डेवलपर दस्तावेज़ीकरण, README फ़ाइलों, स्थैतिक साइट जनरेटर (Jekyll, Hugo, Astro), विकी और knowledge bases के लिए डिफ़ॉल्ट लेखन प्रारूप बन गया है। GitHub, GitLab, Bitbucket, Stack Overflow, Reddit और Notion सभी Markdown को स्वाभाविक रूप से समर्थन करते हैं। चूँकि स्रोत सादा पाठ है, Markdown फ़ाइलें Git से version control करना, branches में diff देखना और किसी फ़ाइल के गैर-अतिव्यापी खंडों में बिना विरोध के मर्ज करना बेहद सरल है।

एक Markdown प्रीव्यू उपकरण आपके इनपुट को पार्स करता है और रियल-टाइम में HTML में बदलता है। इससे आप किसी फ़ाइल को कमिट करने या पृष्ठ प्रकाशित करने से पहले स्वरूपण त्रुटियाँ, टूटे हुए लिंक और अप्रत्याशित नेस्टिंग पकड़ सकते हैं। यह प्रीव्यूअर पूरी तरह आपके ब्राउज़र में चलता है बिना किसी सर्वर राउंड-ट्रिप के, इसलिए आप नेटवर्क पर सामग्री भेजे बिना निजी या संवेदनशील दस्तावेज़ीकरण पर कार्य कर सकते हैं।

ऑनलाइन Markdown प्रीव्यूअर का उपयोग क्यों करें?

बिना प्रीव्यू के सादे संपादक में Markdown लिखने का अर्थ है कि आप आउटपुट का अनुमान लगा रहे हैं। एक लाइव प्रीव्यूअर उस feedback loop को तुरंत बंद कर देता है।

Markdown Preview के उपयोग के मामले

Markdown सिंटैक्स संदर्भ

नीचे दी गई तालिका सामान्य Markdown सिंटैक्स को उसके रेंडर परिणाम और संबंधित HTML तत्व से जोड़ती है। यह CommonMark आधार रेखा को कवर करती है जिसे लगभग हर Markdown पार्सर समर्थन करता है।

Markdown के विभिन्न प्रकारों की तुलना

विभिन्न प्लेटफॉर्म मूल Markdown विनिर्देश को अतिरिक्त सुविधाओं के साथ विस्तारित करते हैं। यह जानना कि आप किस प्रकार को लक्षित कर रहे हैं, उस सिंटैक्स से बचने में मदद करता है जो किसी और रेंडरर में silently fail हो जाता है।

कोड उदाहरण: Markdown को प्रोग्रामेटिक रूप से रेंडर करना

जब आपको ब्राउज़र उपकरण की बजाय किसी application के अंदर Markdown रेंडर करने की आवश्यकता हो, तो इनमें से किसी एक लाइब्रेरी का उपयोग करें। प्रत्येक उदाहरण एक Markdown स्ट्रिंग को HTML स्ट्रिंग में बदलता है।

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>

अक्सर पूछे जाने वाले प्रश्न