Skip to content

barnevis/website

Repository files navigation

وبگاه بَرنویس

وبگاه مجوز زبان


لوگوی برنویس

مشاهده وبگاه زنده

درباره پروژه

این وبگاه ویترین اکوسیستم ابزارهای نگارش فارسی است. این پروژه با هدف معرفی و ارائه دسترسی آسان به مجموعه‌ای از ابزارهای متن‌باز ساخته شده که تجربه نوشتن و ویرایش محتوای فارسی، به ویژه با استاندارد مارک‌داون، را متحول می‌کنند.

داستان برنویس، داستان همکاری خلاقانه انسان و هوش مصنوعی است. برخی از ابزارهای این اکوسیستم به طور کامل توسط مدل‌های هوش مصنوعی پیشرفته توسعه یافته‌اند و برخی دیگر حاصل تلاش و دانش توسعه‌دهندگان ماهر هستند. این وبگاه، خود نیز نمونه‌ای از این همکاری است و با استفاده از جدیدترین فناوری‌های وب برای ارائه بهترین تجربه کاربری طراحی شده است.

ویژگی‌های وبگاه

  • طراحی کاملاً واکنش‌گرا (Responsive): نمایش بی‌نقص در تمام دستگاه‌ها، از موبایل تا دسکتاپ.
  • رابط کاربری مدرن (UI/UX): استفاده از انیمیشن‌های جذاب برای کارت‌ها و دکمه‌ها جهت ایجاد تجربه‌ای پویا.
  • کدنویسی ماژولار و تمیز: ساختار بهینه‌سازی شده CSS و JavaScript برای توسعه و نگهداری آسان.
  • عملکرد سریع: به عنوان یک وبگاه ایستا، سرعت بارگذاری بسیار بالایی دارد.
  • تمرکز بر تایپوگرافی فارسی: استفاده از فونت استاندارد و زیبای وزیرمتن برای اطمینان از خوانایی بالا.

ابزارهای معرفی شده

این وبگاه، ویترین پروژه‌های زیر از اکوسیستم برنویس است:

توسعه یافته با هوش مصنوعی

  • پارس‌نشان: مفسر قدرتمند مارک‌داون برای پردازش محتوای فارسی.
  • دبیر: ویرایشگر کمینه‌گرا و هوشمند با قابلیت ویرایش درجا.
  • پارسی‌نگار: ویرایشگر پیشرفته مارک‌داون با امکانات کامل.
  • ذهن‌نگار: ابزاری برای ساخت و مدیریت نقشه‌های ذهنی.

توسعه یافته توسط توسعه‌دهندگان

  • کراسه: یک موتور وبلاگ ساده مبتنی بر ری‌اکت و مارک‌داون.
  • شه‌نشان: یک تجزیه‌گر مارک‌داون قابل تنظیم و توسعه‌پذیر.

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

این وبگاه با استفاده از فناوری‌های مدرن و استاندارد زیر ساخته شده است:

  • HTML5
  • CSS3 (با ساختار ماژولار BEM-like و متغیرها)
  • JavaScript (ES6+ Modules)
  • Vazirmatn Font (برای تایپوگرافی فارسی)
  • Google Material Symbols (برای آیکون‌ها)

ساختار پروژه

پروژه دارای یک ساختار ماژولار و سازمان‌یافته برای نگهداری و توسعه آسان است:

.
├── about.html              # صفحه درباره ما
├── contribute.html         # صفحه همکاری
├── index.html              # صفحه اصلی
├── assets/
│   ├── css/                # فایل‌های استایل
│   │   ├── base/           # استایل‌های پایه (ریست، متغیرها، تایپوگرافی)
│   │   ├── components/     # کامپوننت‌های قابل استفاده مجدد (دکمه، کارت)
│   │   ├── layout/         # چیدمان کلی (هدر، فوتر)
│   │   ├── pages/          # استایل‌های مختص هر صفحه
│   │   └── main.css        # فایل اصلی برای import کردن همه ماژول‌ها
│   ├── js/                 # فایل‌های جاوااسکریپت
│   │   ├── modules/        # ماژول‌های جداگانه (مثل Typewriter)
│   │   └── main.js         # فایل اصلی جاوااسکریپت
│   └── images/             # تصاویر
│       ├── logos/          # لوگوی پروژه‌ها
│       └── icons/          # آیکون‌های فناوری‌ها
├── components/             # فایل‌های کامپوننت‌های HTML
├── changelog.md            # تاریخچه تغییرات
├── LICENSE                 # مجوز
└── README.md

شروع به کار

از آنجایی که این یک وبگاه ایستا است، برای اجرای آن نیازی به هیچ‌گونه ابزار پیچیده ندارید.

۱. دانلود پروژه

مخزن را کلون کنید:

git clone https://github.com/barnevis/website.git
cd website

۲. اجرای محلی

برای مشاهده وبگاه به صورت محلی، از یکی از روش‌های زیر استفاده کنید:

روش ۱: استفاده از Python (توصیه می‌شود)

# Python 3.x
python -m http.server 8000

# یا Python 2.x
python -m SimpleHTTPServer 8000

سپس مرورگر را باز کرده و به آدرس http://localhost:8000 بروید.

روش ۲: استفاده از Node.js

# نصب http-server (یک بار)
npm install -g http-server

# اجرا
http-server -p 8000

روش ۳: استفاده از PHP

php -S localhost:8000

روش ۴: استفاده از افزونه‌های مرورگر

⚠️ نکته مهم: به دلیل استفاده از ماژول‌های ES6 و بارگذاری داینامیک HTML، باز کردن مستقیم فایل index.html در مرورگر (با پروتکل file://) کار نخواهد کرد. حتماً از یک سرور HTTP محلی استفاده کنید.

همکاری

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

  • گزارش خطا (Bug): اگر مشکلی در وبگاه مشاهده کردید، لطفاً یک Issue جدید باز کنید.
  • درخواست ویژگی جدید: ایده‌ای برای بهبود دارید؟ آن را به عنوان یک Issue مطرح کنید.
  • ارسال Pull Request: اگر مایل به بهبود کدها یا رفع مشکلات هستید، ما از Pull Requestهای شما استقبال می‌کنیم.

لطفاً قبل از شروع، راهنمای مشارکت ما را مطالعه کنید (در آینده اضافه خواهد شد).

مجوز

این پروژه تحت مجوز MIT منتشر شده است. برای اطلاعات بیشتر فایل LICENSE را مشاهده کنید.

About

وبگاه برنویس

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors