mkdocs-rtl
قالب فارسی mkdocs بر پایه‌ی mkdocs-material

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

وابستگی‌ها

۱ـ mkdocs

۲ـ mkdocs-material

نصب

بعد کافیست بصورت زیر پروژه mkdocs-rtl را دانلود کرده و دستور mkdocs serve را اجرا کنید.

git clone https://github.com/mberneti/mkdocs-rtl.git
cd mkdocs-rtl
mkdocs serve

+ این پروژه به همراه قالب‌های سفارشی swagger-ui نسخه یک و دو سفارشی سازی شده‌است.

سفارشی سازی

برای سفارشی سازی قالب مستندات کافیست فایل‌های پوشه‌ی theme را ویرایش کنید.

تولید مستندات

برای تولید مستندات می توانید از دستور mkdocs build استفاده کنید که در نتیجه اجرای آن فایل‌های html نهایی برای انتشار مستندات در پوشه docs تولید می‌شود.

با تشکر از صابر راستی کردار برای قلم آزاد شبنم که در این قالب از آن استفاده شده‌است.