نام (NAME)

markdown — ابزار تبدیل متن به HTML

خلاصه دستور (SYNOPSIS)

markdown [-d] [-T] [-V] [-b url-base] [-C prefix] [-F bitmap] [-f flags] [-n] [-o file] [-S] [-s text] [-t text] [-toc] [textfile]

توضیحات (DESCRIPTION)

ابزار markdown فایل متنی textfile با قالب‌بندی markdown(7) (یا در صورت عدم تعیین، ورودی استاندارد stdin) را خوانده، آن را کامپایل می‌کند و خروجی html را در stdout می‌نویسد.

گزینه‌ها به شرح زیر هستند:

-b url-base

پیوندهای موجود در منبع که با / آغاز می‌شوند، در خروجی پیشوند url-base را دریافت خواهند کرد.

-C

هنگام پردازش پانویس‌های سبک markdown extra، به‌جای پیشوند پیش‌فرض fn از پیشوند ارائه‌شده استفاده کن.

-d

به‌جای نوشتن فایل html، درخت تجزیه (parse tree) را در خروجی استاندارد بنویس.

-f flags

تنظیم یا پاک کردن فلگ‌های گوناگون ترجمه. فلگ‌ها در یک لیست با کاما جدا شده و هر فلگ می‌تواند پیشوند اختیاری + (فعال‌سازی)، - (غیرفعال‌سازی) یا no (غیرفعال‌سازی) داشته باشد.

links

اجازه به پیوندها.

image

اجازه به تصاویر.

smarty

فعال‌سازی smartypants.

pants

فعال‌سازی smartypants.

html

اجازه به کدهای خام html.

strict

غیرفعال‌سازی بالانویس، خط‌خورده و تاکیدهای آزاد.

ext

فعال‌سازی شبه‌پروتکل‌ها.

cdata

تولید کد برای ![CDATA[...]] در xml.

superscript

فعال‌سازی پردازش بالانویس (superscript).

emphasis

اعمال تاکید در همه‌جا.

tables

پردازش نکردن جدول‌های سبک PHP Markdown Extra.

del

فعال‌سازی ~~خط‌خورده~~.

strikethrough

فعال‌سازی ~~خط‌خورده~~.

toc

فعال‌سازی پردازش فهرست مطالب (table-of-contents).

1.0

سازگاری با MarkdownTest_1.0.

autolink

تبدیل http://foo.com به پیوند حتی بدون <>.

safelink

بررسی سخت‌گیرانه برای پروتکل پیوند.

header

پردازش بلوک‌های عنوان به سبک pandoc.

tabstop

بسط دادن تب‌ها به ۴ فاصله (spaces).

divquote

اجازه دادن به بلوک‌های >%class%.

alphalist

اجازه دادن به لیست‌های الفبایی.

definitionlist

اجازه به لیست‌های تعریفی (پیش‌فرض). استفاده از dldiscount و dlextra برای کنترل اینکه کدام نحوها پذیرفته شوند.

dldiscount

فعال‌سازی لیست‌های تعریفی به سبک discount (پیش‌فرض).

dlextra

فعال‌سازی لیست‌های تعریفی به سبک extra (غیر پیش‌فرض). هر دو سبک می‌توانند همزمان فعال باشند.

footnote

اجازه به پانویس‌های سبک markdown extra.

style

استخراج بلوک‌های <style> از خروجی.

fencedcode

اجازه به بلوک‌های کد محصور (fenced code blocks) (غیر پیش‌فرض).

idanchor

استفاده از لنگرهای id= برای پیوندهای فهرست مطالب به‌جای <a name=/> (غیر پیش‌فرض).

githubtags

اجازه به خط زیر (underscore) و خط تیره (dash) در نام‌های عناصر عبور داده شده (غیر پیش‌فرض).

urlencodedanchor

استفاده از نویسه‌های url-encoded برای نویسه‌های چندبایتی و غیرالفبایی-عددی به‌جای نقطه در پیوندهای فهرست مطالب.

به‌عنوان مثال، گزینه -f nolinks,smarty به markdown می‌گوید که تگ‌های <a را مجاز نداند و پردازش smartypants را انجام دهد.

-F bitmap

تنظیم فلگ‌های تبدیل. Bitmap یک نگاشت بیتی از گزینه‌های مختلف پیکربندی است که در markdown(3) توصیف شده‌اند (مقادیر فلگ در mkdio.h تعریف شده‌اند).

-n

کدهای html تولیدشده را ننویس.

-o file

نوشتن کدهای html تولیدشده در file.

-S

خروجی دادن بلوک‌های <style>.

-V

نمایش شماره نسخه و داده‌های پیکربندی زمان کامپایل.

اگر نسخه شامل رشته DEBUG باشد، markdown با دیباگ تخصیص حافظه پیکربندی شده است.

اگر نسخه شامل رشته TAB باشد، markdown برای استفاده از tabstop مشخص‌شده پیکربندی شده است.

-VV

نمایش شماره نسخه، پیکربندی زمان کامپایل و پیکربندی زمان اجرا.

-t text

استفاده از mkd_text(3) برای قالب‌بندی text به‌جای پردازش ورودی استاندارد با تابع markdown(3).

-T

اگر با فلگ فهرست مطالب اجرا شود، فهرست مطالب را قبل از متن قالب‌بندی‌شده درج کن.

-s text

استفاده از تابع markdown(3) برای قالب‌بندی text.

-toc

تنظیم فلگ فهرست مطالب، سپس درج فهرست مطالب قبل از متن قالب‌بندی‌شده (میانبری برای --T --toc ).

مقادیر بازگشتی (RETURN VALUES)

ابزار markdown در صورت موفقیت مقدار 0 و در صورت بروز خطا مقدار >0 را برمی‌گرداند.

همچنین ببینید (SEE ALSO)

markdown(3), markdown(7), mkd-extensions(7).

نویسنده (AUTHOR)

David Parsons (orc@pell.portland.or.us)