برای ساخت وب سایت از Hugo که یک static site generator است استفاده شده، و محتوای مطالب آن در فایل های markdown نگه داری می‌شود.

همچنین برای ایجاد فرمول های ریاضی از Latex استفاده شده.

در قدم اول برای مشارکت باید اقدام به راه اندازی وب سایت بر روی سیستم شخصی خود کنید، لطفا مراحل زیر را انجام دهید:

1. نصب Hugo:

https://gohugo.io/getting-started/installing

2. ایجاد یک fork از این ریپو، و سپس clone کردن آن.
3. اجرای وب سایت:

دستور زیر را در پوشه اصلی پروژه اجرا کنید.

hugo serve

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

http:https://localhost:1313/ml-andrew-ng/

بعد از راه اندازی به ویرایش مطالب می‌پردازیم:

تمامی مطالب وب سایت که در فایل های md. قرار دارند در پوشه content هستند، بسته به اینکه قصد ویرایش کدام مطلب را دارید پوشه مورد نظر را در آن انتخاب کنید و سپس فایل مورد نظر را برای ویرایش باز کنید.

اگر فایل مورد نظر شما از قبل وجود دارد شروع به نوشتن و ویرایش کردن در فایل کنید، و نیازی به تغییر قسمت بالایی فایل که شامل عنوان و زمان ساخت فایل و غیره است نیست.

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

دستور زیر را در پوشه اصلی در ترمینال اجرا کنید، قسمت purpose_directory اسم پوشه مورد نظر شما است که می‌خواهید فایل جدید درآن جا باشد، و name_of_file نیز اسم فایل است.

نکته:

اگر در حال ساخت یک پوشه کاملا جدید هستید، یعنی بخش جدیدی به وب سایت اضافه می‌کنید، باید در آن پوشه جدید ابتدا با استفاده از دستور زیر فایلی به اسم index.mdـ بسازید، و شبیه به بقیه پوشه ها آن را ویرایش کنید.

hugo new purpose_directory/name_of_file.md

مثلا:

hugo new week1/what-is-ml.md

hugo new new/_index.md

بعد از انجام ویرایش مطالب شروع به فرستادن تغییرات کنید:

برای ارسال تغییرات بعد از commit کردن ویرایش های خود در ریپو ای که fork کردید، نیاز به ساخت یک pull request دارید. به این قسمت بروید و درخواست خود را با یک عنوان مناسب و توضیحات مربوطه ایحاد کنید.

بعد از بررسی تغییرات شما اعمال خواهد شد.

ممنون!