پیش‌نمایش Markdown

Markdown چیست؟

Markdown یک زبان نشانه‌گذاری سبک‌وزن است که در سال ۲۰۰۴ توسط John Gruber ساخته شد. این زبان از نمادهای قالب‌بندی متن ساده مانند ستاره‌ها، علامت‌های هشتگ و خط‌فاصله برای نشان‌دادن ساختار استفاده می‌کند: عناوین، متن پررنگ، متن کج، لیست‌ها، پیوندها و بلوک‌های کد. یک ابزار پیش‌نمایش Markdown این متن ساده را به HTML قالب‌بندی‌شده تبدیل می‌کند تا بتوانید دقیقاً ببینید سند نهایی قبل از انتشار چه شکلی خواهد داشت. مشخصات اصلی Markdown در مستندات Daring Fireball نوشته Gruber توضیح داده شده و این قالب از آن زمان به‌صورت CommonMark رسمی شده است.

Markdown به قالب نوشتاری پیش‌فرض برای مستندات توسعه‌دهندگان، فایل‌های README، مولدهای سایت استاتیک (Jekyll، Hugo، Astro)، ویکی‌ها و پایگاه‌های دانش تبدیل شده است. GitHub، GitLab، Bitbucket، Stack Overflow، Reddit و Notion همگی به‌طور بومی از Markdown پشتیبانی می‌کنند. از آنجا که منبع آن متن ساده است، فایل‌های Markdown با Git به‌راحتی کنترل نسخه می‌شوند، در شاخه‌های مختلف مقایسه می‌شوند و در بخش‌های غیرمتداخل یک فایل بدون تعارض ادغام می‌شوند.

یک ابزار پیش‌نمایش Markdown ورودی شما را تجزیه کرده و در زمان واقعی به HTML تبدیل می‌کند. این امکان را می‌دهد که خطاهای قالب‌بندی، پیوندهای شکسته و تودرتوی ناخواسته را قبل از ثبت فایل یا انتشار صفحه شناسایی کنید. این ابزار پیش‌نمایش کاملاً در مرورگر شما اجرا می‌شود و نیاز به ارسال درخواست به سرور ندارد، بنابراین می‌توانید روی مستندات خصوصی یا حساس بدون ارسال محتوا از طریق شبکه کار کنید.

چرا از ابزار پیش‌نمایش Markdown آنلاین استفاده کنیم؟

نوشتن Markdown در یک ویرایشگر ساده بدون پیش‌نمایش به معنای حدس‌زدن درباره خروجی است. یک ابزار پیش‌نمایش زنده این حلقه بازخورد را فوراً می‌بندد.

موارد استفاده از پیش‌نمایش Markdown

مرجع نحو Markdown

جدول زیر نحو رایج Markdown را به نتیجه رندرشده و عنصر HTML مربوطه نگاشت می‌کند. این پایه CommonMark را پوشش می‌دهد که تقریباً هر تجزیه‌کننده Markdown آن را پشتیبانی می‌کند.

مقایسه نسخه‌های Markdown

پلتفرم‌های مختلف مشخصات اصلی Markdown را با ویژگی‌های اضافی گسترش می‌دهند. دانستن اینکه کدام نسخه را هدف قرار می‌دهید به شما کمک می‌کند از نحوی که در رندرکننده‌های دیگر بی‌سروصدا خراب می‌شود دوری کنید.

نمونه‌های کد: رندر Markdown به‌صورت برنامه‌نویسی

وقتی نیاز دارید 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>

سؤالات متداول