Skip to content

Repository files navigation

DOCGenius 🚀

### مولد اسناد HTML ماژولار و زیبا

ابزار DOCGenius یک ابزار تحت وب و قدرتمند است که به شما اجازه می‌دهد اسناد فنی، آموزشی و راهنماهای زیبا را به صورت ماژولار و بدون نیاز به یک خط کدنویسی بسازید. خروجی نهایی، یک فایل HTML مستقل، سبک و کاملاً واکنش‌گراست که می‌توانید آن را در هر جایی به اشتراک بگذارید.

DOCGenius Demo


✨ ویژگی‌های کلیدی

  • معماری کاملاً ماژولار: هر سند از "شاخه‌های اصلی" تشکیل شده و هر شاخه می‌تواند شامل "زیرشاخه‌ها" باشد.
  • کنترل کامل بر محتوا: به هر شاخه یا زیرشاخه، به هر تعداد، بلوک توضیحات یا بلوک کد اضافه کنید.
  • ویرایشگر پیشرفته (WYSIWYG): برای بخش توضیحات از یک ویرایشگر قدرتمند با قابلیت‌های کامل (فرمت‌بندی، رنگ، لیست، لینک و...) استفاده کنید.
  • درج تصویر به صورت Embed: تصاویر خود را مستقیماً از کامپیوتر انتخاب کنید تا به صورت Base64 در فایل HTML نهایی Embed شوند. بدون نیاز به آپلود جداگانه!
  • رنگ‌بندی داینامیک و هوشمند: هر شاخه اصلی و زیرشاخه‌های آن به صورت خودکار یک پالت رنگی هماهنگ و زیبا دریافت می‌کنند تا از نظر بصری متمایز باشند.
  • کنترل کامل جهت‌گیری (RTL/LTR): جهت‌گیری هر شاخه را به صورت مستقل و با یک سوییچ زیبا تعیین کنید.
  • رندر هوشمند: بخش‌های خالی (عنوان، توضیحات یا کد) به صورت خودکار در خروجی نهایی حذف می‌شوند تا کدی تمیز و بهینه تولید شود.
  • خروجی تک‌فایل و قابل حمل: فایل نهایی یک سند HTML واحد است که می‌توانید آن را به راحتی در هر جایی به اشتراک بگذارید یا میزبانی کنید.
  • طراحی زیبا و مدرن: هم خود جنریتور و هم فایل خروجی، دارای یک رابط کاربری تمیز، حرفه‌ای و لذت‌بخش هستند.

🎯 چه کسانی می‌توانند از DOCGenius استفاده کنند؟

  • توسعه‌دهندگان نرم‌افزار: برای ساخت سریع مستندات API، راهنمای نصب و آموزش‌های فنی.
  • مدرسان و تولیدکنندگان محتوای آموزشی: برای ایجاد جزوات و مطالب آموزشی تعاملی و زیبا.
  • تیم‌های محصول: برای نوشتن راهنمای کاربری و مستندات داخلی.
  • هر کسی که نیاز به ساخت یک صفحه وب اطلاعاتی، سریع و بدون دردسر دارد.

🚀 نحوه استفاده

استفاده از DOCGenius فوق‌العاده ساده است:

  1. به لینک جنریتور بروید.
  2. یک شاخه اصلی بسازید: با کلیک روی دکمه "افزودن شاخه اصلی"، اولین بلوک شما ساخته می‌شود.
  3. محتوا اضافه کنید:
    • برای شاخه خود یک عنوان بنویسید.
    • با استفاده از دکمه‌های "+ توضیحات" و "+ کد"، هر تعداد بلوک محتوا که نیاز دارید اضافه کنید.
    • از ویرایشگر پیشرفته برای فرمت‌بندی متن و درج تصاویر استفاده کنید.
  4. زیرشاخه‌ها را اضافه کنید: در صورت نیاز، با کلیک روی دکمه "افزودن زیرشاخه"، ساختار تودرتوی خود را ایجاد کنید.
  5. تنظیمات را وارد کنید: متن فوتر دلخواه خود را در بخش تنظیمات وارد کنید.
  6. تولید و کپی کنید! با کلیک روی دکمه "تولید و کپی کد"، کل فایل HTML نهایی در کلیپ‌بورد شما کپی می‌شود. آن را در یک فایل با پسوند .html ذخیره کرده و از نتیجه لذت ببرید!

🛠️ تکنولوژی‌های استفاده شده

  • HTML5 & CSS3: برای ساختار و استایل‌دهی مدرن.
  • JavaScript (Vanilla JS): برای تمام منطق‌های داینامیک و تعاملی برنامه.
  • jQuery: به عنوان وابستگی اصلی ویرایشگر Trumbowyg.
  • Trumbowyg: یک ویرایشگر WYSIWYG سبک، قدرتمند و قابل سفارشی‌سازی.

🤝 مشارکت و بازخورد

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


کپی‌رایت

طراحی و توسعه توسط حامد زندیه (hamed.zandieh@gmail.com).

About

مولد اسناد HTML ماژولار

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages