این سایت با استفاده از Docusaurus که یک سایت ساز مدرن است ساخته شده است.
برای ویرایش این سایت کافیست این مخزن را کلون کنید و سپس فایل های مارک داون داخل دایرکتوری های docs و blog را ویرایش نمایید.
git clone https://github.com/AP-ECE-UT/AP-ECE-UT.github.io.git
در صورتی که تغییرات شما روی شاخه main
پذیرفته شود، مستقیما روی سایت دیپلوی میگردد.
تقریبا تمام منوها و آدرسها به صورت خودکار و بر اساس ساختار فایل های docs ساخته میشوند. در این دایرکتوری بخش های مختلف سایت به صورت دایرکتوری های مجزا موجودند و هر بخش شامل تعدادی دایرکتوری و فایل مارک داون است. در نوار سمت راست سایت، دایرکتوری ها به صورت کتگوری و فایل ها به صورت صفحات رندر خواهند شد. از استفاده از حروف فارسی در نامگذاری دایرکتوری ها و فایل ها خودداری کنید. برای نامگذاری فارسی کتگوری ها به فایل _category_.json
در آن دایرکتوری مراجعه کنید. برای نامگذاری فارسی صفحات کافیست نام مورد نظر را در یک هدینگ 1 # Heading 1
ابتدای فایل قرار دهید.
docs
├───course
| └───materials.md
├───tutorials
| └───intro.md
└───index.md
برای اجرای پیش نمایش لوکال این سایت، باید رانتایم node و پکیج منیجر npm را روی سیستم خود داشته باشید. آموزش نصب
سپس وارد مخزن کلون شده شوید و با دستور زیر پکیج های مورد نیاز را نصب نمائید:
npm install
سپس با دستور زیر آن را روی لوکال هاست اجرا نمایید و مشاهده کنید:
npm run start