BusyMark – ویرایشگر Markdown و Writerside برای مستندات حرفه‌ای در Linux

Markdown

قالب‌بندی و فهرست‌های کار

مستندات Writerside

کنترل‌های فراخوان

Writerside Markdown از ویرایش دیداری و منبع پشتیبانی می‌کند. موضوع‌های XML با ویرایش منبع کار می‌کنند.

نمودارها، مراجع API و ریاضیات

نمودار رندرشدهٔ Mermaid

حالت‌های ویرایش

Markdown را می‌توان به‌صورت محتوای قالب‌بندی‌شده یا متن منبع ویرایش کرد. حالت‌های خواندن و تقسیم دو راه برای بررسی نتیجهٔ رندرشده هستند.

ویرایشگر

ویرایش دیداری Markdown

حالت ویرایشگر با ابزارهای قالب‌بندی سند.

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

متن منبع

دسترسی مستقیم به نشانه‌گذاری

حالت منبع با برجسته‌سازی نحو Markdown.

نشانه‌گذاری Markdown و Writerside با شمارهٔ خط، برجسته‌سازی و تاخوردگی مستقیماً قابل ویرایش می‌ماند. حالت منبع این ویرایشگر را بدون پنل پیش‌نمایش نشان می‌دهد.

خواندن

سند رندرشده

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

نوار ابزار قالب‌بندی وجود ندارد. عنوان‌ها، نمودارها و دیگر محتوای سند بدون نشانه‌های Markdown نمایش داده می‌شوند.

تقسیم‌شده

منبع در کنار نتیجهٔ رندرشده

نمای تقسیم‌شده · معماری تحویل رویداد

منبع و سند رندرشده هم‌زمان دیده می‌شوند. تعریف نمودارها را می‌توان کنار نمودارهای حاصل بررسی کرد.

ویرایش دیداری برای Markdown و Writerside Markdown کاربرد دارد؛ اسناد XML با پسوند .topic در متن منبع ویرایش می‌شوند.

یکپارچگی با Git

تغییرات مستندات، کامیت‌ها و تاریخچهٔ مخزن در فضای کاری ویرایش.

BusyMark از ابزارهای خط فرمان Git نصب‌شده و گردش‌کار موجود مخزن استفاده می‌کند.

بازبینی تغییرات

بازبینی فایل، افزودن به مرحله، خارج‌کردن از مرحله و کامیت‌ها.

تاریخچهٔ فایل و تاریخچهٔ پروژه

نماهای جداگانهٔ تاریخچهٔ فایل و پروژه، مقایسه با سند کاری و بازیابی نسخه‌های پیشین فایل.

شاخه‌ها و راه‌دورها

ساخت و تعویض شاخه، fetch، pull با fast-forward و push.

خروجی PDF و HTML

خروجی از یک سند Markdown یا نمونهٔ انتخاب‌شدهٔ Writerside.

PDF

چیدمان صفحه و تایپوگرافی، مستقل از ظاهر ویرایشگر.

چیدمان
اندازه، جهت و حاشیه‌های صفحه.
تایپوگرافی
اندازهٔ متن و کد و رنگ تأکیدی.
پیمایش
فهرست مطالب، سربرگ، پابرگ و شمارهٔ صفحه.

HTML

سندهای قابل‌حمل و صفحه‌های موضوع پیوندخورده که بدون BusyMark خوانده می‌شوند.

ظاهر
پوسته، تایپوگرافی، عرض محتوا و رنگ تأکیدی.
منابع
منابع توکار یا پوشهٔ assets.
سبک‌ها
یک شیوه‌نامهٔ سفارشی اختیاری.

خروجی HTML ‏Writerside صفحات موضوع پیوندشده و فهرست را حتی با منابع توکار نگه می‌دارد.

BusyMark خروجی بومی فراهم می‌کند و سازندهٔ انتشار JetBrains را اجرا نمی‌کند.

دستیار هوش مصنوعی

Ollama · OpenAI · Gemini

ویرایش سند

دستور صریح، هدف تغییر و زمینهٔ سند، همراه با بازبینی تفاوت پیش از اعمال.

پیشنهاد پیام کامیت

پیام کامیت پیشنهادی بر پایهٔ تفاوت stage‌شدهٔ Git.

به‌طور پیش‌فرض غیرفعال است. Ollama محلی اجرا می‌شود؛ درخواست‌های ابری از ارائه‌دهندهٔ انتخابی استفاده می‌کنند.

Markdown و HTML

بلوک‌های Markdown

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

عنوان‌ها

#, ##, ###

پاراگراف‌ها

text

نقل‌قول بلوکی

> quote

بلوک کد

```

فهرست‌ها

-, *, 1.

چک‌لیست

- [ ]

جدول

| --- |

تصویر

![alt](src)

جداکنندهٔ موضوعی

---

Markdown درون‌خطی

قالب‌بندی درون پاراگراف‌ها، موارد فهرست و سلول‌های جدول.

پررنگ

**text**

مورب

*text*

زیرخط‌دار

<u>text</u>

خط‌خورده

~~text~~

کد درون‌خطی

`code`

پیوند

[text](url)

شکست خط اجباری

<br>

بلوک‌های HTML خام

تگ‌های بلوکی HTML امن که با ویجت‌های پیش‌نمایش BusyMark نمایش داده می‌شوند.

article, aside, div, section, header, footer, main, nav, h1-h6, p, blockquote, address, hr, ul, ol, li, dl, dt, dd, table, caption, colgroup, col, thead, tbody, tfoot, tr, th, td, pre, details, summary, figure, figcaption.

کانتینرها

div, section

بلوک‌های متن

p, h1-h6

فهرست‌ها

ul, ol, li

جدول

table, tr, td

شکل‌ها و تصاویر

figure, img

کد پیش‌قالب‌بندی‌شده

pre, code

بلوک‌های بازشونده

details

فهرست‌های توصیفی

dl, dt, dd

تگ‌های HTML درون‌خطی

تگ‌های HTML درون‌خطی امن بدون نمایش خود تگ‌ها رندر می‌شوند.

span, strong, em, b, i, u, s, small, mark, sub, sup, code, kbd, samp, var, abbr, cite, q, dfn, time, data, bdi, bdo, wbr, ins, del, ruby, rt, rp, a, img, br.

تگ‌های قالب‌بندی

strong, em, u

تگ‌های کد درون‌خطی

kbd, samp, var

پیوند

a[href]

تصویر درون‌خطی

img[src]

تگ‌های متنی معنایی

span, time

شکست خط اجباری

br, wbr

قوانین امنیتی

HTML خام پیش از پیش‌نمایش تحلیل و پاک‌سازی می‌شود.

پیش‌نمایش پاک‌سازی‌شده

HTML مجاز به بلوک‌های پیش‌نمایش BusyMark تبدیل می‌شود، نه اینکه در مرورگر رندر شود.

منبع حفظ می‌شود

HTML خام ویرایش‌نشده دقیقاً به‌عنوان متن منبع ذخیره می‌شود.

Markdown داخل HTML

نشانه‌های Markdown داخل HTML خام به‌صورت متن واقعی نمایش داده می‌شوند.

محتوای فعال مسدود است

اسکریپت‌ها، استایل‌ها، فریم‌ها، فرم‌ها، SVG، MathML، رویدادها و ویژگی‌های ناامن مسدود می‌شوند.

فقط URLهای امن

پیوندها http، https، mailto، tel، URLهای نسبی و قطعه‌ها را می‌پذیرند؛ طرح‌های ناامن مسدود می‌شوند.

میانبرهای صفحه‌کلید

عمومی

سند جدید

ایجاد فایل Markdown یا پروژهٔ Writerside

Ctrl+N

باز کردن

باز کردن فایل Markdown، پوشه یا پروژهٔ Writerside

Ctrl+O

ذخیره

ذخیرهٔ سند فعلی

Ctrl+S

خروجی به‌صورت PDF

یک سند Markdown یا نمونهٔ انتخاب‌شدهٔ Writerside را به PDF صادر کنید.

Ctrl+Shift+E

خروجی به‌صورت HTML…

منوی اصلی یا پالت فرمان. میان‌بر پیش‌فرض صفحه‌کلید ندارد.

پالت فرمان

یافتن فرمان برنامه

Ctrl+Shift+P

تمام‌صفحه

F11

بازگشت

Alt+Left

جستجو

جستجو در فضای کاری فعلی

Ctrl+F

میانبرهای صفحه‌کلید

نمایش مرجع میانبرهای صفحه‌کلید

Ctrl+Alt+K

Markdown و HTML

باز کردن مرجع Markdown و HTML

Ctrl+Alt+M

تنظیمات

باز کردن تنظیمات BusyMark

Ctrl+Alt+S

تب‌ها

تب بعدی

رفتن به تب باز بعدی

Ctrl+Tab

تب قبلی

رفتن به تب باز قبلی

Ctrl+Shift+Tab

بستن تب

بستن تب فعال

Ctrl+W

بستن همهٔ تب‌ها

بستن همهٔ تب‌های باز

Ctrl+Shift+W

حالت نمایش

ویرایشگر

Ctrl+Shift+1

متن منبع

Ctrl+Shift+2

حالت مطالعه

Ctrl+Shift+3

تقسیم‌شده

Ctrl+Shift+4

ویرایش متن

انتخاب همه

در حالت منبع، همهٔ متن را انتخاب کنید؛ در حالت ویرایشگر، برای انتخاب همهٔ بلوک‌ها دو بار فشار دهید

Ctrl+A

برش

برش متن انتخاب‌شده

Ctrl+X

کپی

کپی متن انتخاب‌شده

Ctrl+C

جای‌گذاری

جای‌گذاری از کلیپ‌بورد

Ctrl+V

جای‌گذاری بدون قالب‌بندی

جای‌گذاری متن کلیپ‌بورد بدون قالب‌بندی

Ctrl+Shift+V

واگرد

آخرین ویرایش را واگرد کنید

Ctrl+Z

انجام دوباره

آخرین ویرایش واگردشده را دوباره انجام دهید

Ctrl+Shift+Z

درج تورفتگی

درج تورفتگی در مکان‌نما

Tab

کاهش تورفتگی در حالت منبع

حذف یک سطح تورفتگی در حالت منبع

Shift+Tab

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

بستن جستجوی فضای کاری یا لغو انتخاب بلوک‌ها در حالت ویرایشگر

Esc

قالب‌بندی

پررنگ

فعال یا غیرفعال کردن پررنگی متن انتخاب‌شده

Ctrl+B

مورب

فعال یا غیرفعال کردن حالت مورب متن انتخاب‌شده

Ctrl+I

زیرخط‌دار

فعال یا غیرفعال کردن زیرخط متن انتخاب‌شده

Ctrl+U

پیوند

درج یا ویرایش پیوند

Ctrl+K

کد درون‌خطی

فعال یا غیرفعال کردن کد درون‌خطی برای متن انتخاب‌شده

Ctrl+Shift+`

خط‌خورده

فعال یا غیرفعال کردن خط‌خوردگی متن انتخاب‌شده

Alt+Shift+5

بلوک‌ها

پاراگراف

تنظیم بلوک فعلی روی پاراگراف

Ctrl+Alt+0

عنوان ۱

تنظیم بلوک فعلی روی عنوان ۱

Ctrl+Alt+1

عنوان ۲

تنظیم بلوک فعلی روی عنوان ۲

Ctrl+Alt+2

عنوان ۳

تنظیم بلوک فعلی روی عنوان ۳

Ctrl+Alt+3

عنوان ۴

تنظیم بلوک فعلی روی عنوان ۴

Ctrl+Alt+4

عنوان ۵

تنظیم بلوک فعلی روی عنوان ۵

Ctrl+Alt+5

عنوان ۶

تنظیم بلوک فعلی روی عنوان ۶

Ctrl+Alt+6

نقل‌قول بلوکی

Ctrl+Shift+Q

بلوک کد

Ctrl+Shift+K

فهرست‌ها

فهرست شماره‌دار

فعال یا غیرفعال کردن قالب‌بندی فهرست شماره‌دار

Ctrl+Shift+7

فهرست نشانه‌دار

فعال یا غیرفعال کردن قالب‌بندی فهرست نشانه‌دار

Ctrl+Shift+8

چک‌لیست

فعال یا غیرفعال کردن قالب‌بندی چک‌لیست

Ctrl+Shift+9

افزایش تورفتگی مورد فهرست

Ctrl+]

کاهش تورفتگی مورد فهرست

Ctrl+[

درج

تصویر

Ctrl+Shift+I

شکست خط اجباری

Shift+Enter

نوار کناری

پنل کناری

F9

فایل‌ها

Ctrl+1

فهرست مطالب

Ctrl+2

ساختار سند

عنوان‌های سند در نوار کناری

Ctrl+3

Git

Ctrl+4

حذف

حذف مورد انتخاب‌شده در فایل‌ها یا برداشتن موضوع انتخاب‌شده از فهرست مطالب

Delete

دستیار متن منبع

رفتن به اعلان

به اعلان نماد زیر مکان‌نما بروید.

Ctrl+B

یافتن کاربردها

ارجاع‌های یک نماد Writerside

Alt+F7

تغییر نام

نماد پشتیبانی‌شدهٔ Writerside و کاربردهایش

Shift+F6