شروع کنید

شروع کنید

شروع سریع از طریق Template

 imfing/hextra-starter-template

با استفاده از template در بالای صفحه‌ای مخزن می‌توانید به سرعت شروع به کار کنید.

ما یک گردش کاری GitHub Actions ارائه کرده‌ایم که می‌تواند به ساخت و به‌کاراندازی خودکار سایت شما در گیت‌هاب Pages، برای میزبانی رایگان کمک کند. برای گزینه‌های بیشتر، به‌کاراندازی سایت را بررسی کنید.

🌐 نسخه‌ي نمایشی ↖

شروع به عنوان پروژه جدید

دو راه اصلی برای اضافه کردن تم هگزترا به پروژه Hugo وجود دارد:

  1. ماژول‌های Hugo (توصیه می‌شود): ساده‌ترین و توصیه شده‌ترین. ماژول‌های Hugo به شما امکان می‌دهند تم را مستقیما از منبع آنلاین آن وارد کنید. تم به صورت خودکار دانلود و توسط Hugo مدیریت می‌شود.
  2. ساب‌ماژول گیت: در عوض، هگزترا را به عنوان یک ساب‌ماژول گیت اضافه کنید. تم توسط گیت دانلود شده و در پوشه themes پروژه شما ذخیره می‌شود.

هگزترا را به عنوان ماژول Hugo راه‌اندازی کنید

پیش‌نیازها

قبل از شروع، باید این نرم‌افزارها را نصب کنید:

مراحل

راه‌انداختن یک سایت جدید Hugo

hugo new site my-site --format=yaml

پیکربندی تم هگزترا از طریق ‌ماژول

# مقداردهی اولیه ماژول هیوگو
cd my-site
hugo mod init github.com/username/my-site

# افزودن تم هگزترا
hugo mod get github.com/imfing/hextra

با افزودن موارد زیر، hugo.yaml را برای استفاده از تم هگزترا پیکربندی کنید:

module:
  imports:
    - path: github.com/imfing/hextra

اولین صفحه‌های محتوای خود را ایجاد کنید

ایجاد صفحه محتوای جدید برای صفحه اصلی و صفحه مستندات:

hugo new content/_index.md
hugo new content/docs/_index.md

پیش‌نمایش سایت به صورت محلی

hugo server --buildDrafts --disableFastRender

پیش‌نمایش سایت جدید شما در http://localhost:1313/ در دسترس است.

چگونه تم را به‌روز کنیم؟

برای به‌روزرسانی همه ماژول‌های Hugo در پروژه خود به آخرین نسخه‌هایشان، دستور زیر را اجرا کنید:

hugo mod get -u

برای به‌روزرسانی هگزترا به آخرین نسخه منتشر شده، دستور زیر را اجرا کنید:

hugo mod get -u github.com/imfing/hextra

برای جزئیات بیشتر به ماژول‌های هیوگو مراجعه کنید.

هگزترا را به عنوان ساب‌ماژول Git راه‌اندازی کنید

پیش‌نیازها

قبل از شروع، باید این نرم‌افزارها را نصب کنید:

مراحل

راه‌انداختن یک سایت جدید Hugo

hugo new site my-site --format=yaml

افزودن تم هگزترا به عنوان یک ساب‌ماژول Git

git submodule add https://github.com/imfing/hextra.git themes/hextra

با افزودن موارد زیر، hugo.yaml را برای استفاده از تم هگزترا پیکربندی کنید:

theme: hextra

اولین صفحه‌های محتوای خود را ایجاد کنید

ایجاد صفحه محتوای جدید برای صفحه اصلی و صفحه مستندات:

hugo new content/_index.md
hugo new content/docs/_index.md

پیش‌نمایش سایت به صورت محلی

hugo server --buildDrafts --disableFastRender

پیش‌نمایش سایت جدید شما در http://localhost:1313/ در دسترس است.

هنگام استفاده از CI/CD برای به‌کاراندازی وب‌سایت Hugo، از اجرای دستور زیر قبل از اجرای دستور hugo مطمئن شوید و ضروری است.

git submodule update --init

اجرا نشدن این دستور باعث می‌شود که پوشه تم با پرونده‌های تم هگزترا پر نشود و منجر به خرابی ساخت شود.

چگونه تم را به‌روز کنیم؟

برای به‌روزرسانی تمام ساب‌ماژول‌های در مخزن خود به آخرین commitها که موجود هست، دستور زیر را اجرا کنید:

git submodule update --remote

برای به‌روزرسانی هگزترا به آخرین commit، دستور زیر را اجرا کنید:

git submodule update --remote themes/hextra

برای جزئیات بیشتر به ساب‌ماژول‌های Git مراجعه کنید.

بعدی

برای شروع اضافه کردن مطالب بیشتر، بخش‌های زیر را کاوش کنید:

آخرین به‌روزرسانی در