docute-fa v0.1.7

مستندسازی به راحتی هر چه تمام تر!

از کجا اومده ؟

این پروژه یک انشعاب(فورک) از ابزار داکیوت است که اولین بار در آزمایشگاه KN2C برای ساخت مستندات لیگ شبیه‌سازی دوبعدی فوتبال استفاده شد. این برنامه همچنان به صورت آزاد منتشر شده است و استفاده آن در پروژه‌های شما نه تنها بد نیست بلکه بسیار پسندیده است.

ویژگی‌ها

• بدون نیاز به بیلد، مستنداتتان به سرعت ایجاد میشوند.
• طراحی ساده و قدرتمند ساخته شده برای مستند سازی.
• با قابلیت استفاده از قدرت VUE و Markdown.
• دارای سیستم افزونه‌پذیر به همراه تعداد زیادی افزونه‌های رسمی

مستندات این پروژه

متاسفانه هنوز مستنداتی به زبان فارسی برای این پروژه تهیه نشده است ولی شما همچنان میتوانید از مستندات اصلی پروژه استفاده کنید. تمام موارد آورده شده در مستندات پروژه، در نسخه فارسی آن نیز کار میکنند به جز موارد آورده شده در پایین تر! همچنین مواردی نیز این پروژه بیشتر از پروژه اصلی دارد.

• v4 (latest) docs: https://docute.org

چه چیز‌هایی کار نمیکنند ؟

• هایلایت خطوط کد

اگر در زمان استفاده از پروژه به موردی برخوردید که برای شما کار نکرد دو راه کار وجود دارد:

1- دست به کار شوید و آن‌ها را درست کنید!

2- از طریق گیتهاب ایشیو بزنید یا با این ایمیل با من در تماس باشید :‌ sadraiiali@gmail.com

منابع

• پلاگین‌های رسمی
• Awesome Docute

نحوه‌ی مشارکت

1. پروژه را انشعاب (fork) کنید.
2. شاخه تغییرات خودتان را ایجاد کنید : git checkout -b my-new-feature
3. تغییراتتان را Commit کنید : git commit -am 'Add some feature'
4. تغییراتتان را Push کنید : git push origin my-new-feature
5. در نهایت یک Pull Request بسازید. :D

اگر علاقمند به توسعه پروژه‌های متن‌باز عام المنفعه هستید حتما فسفر را دنبال کنید.

Author

Docute © EGOIST, Released under the MIT License. Authored and maintained by EGOIST with help from contributors (list).

Website · GitHub @EGOIST · Twitter @_egoistlily

License