شروع به کار

شروع به کار

شروع سریع با قالب

 imfing/hextra-starter-template

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

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

🌐 نسخه نمایشی ↗

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

دو روش اصلی برای افزودن تم Hextra به پروژه Hugo شما وجود دارد:

  1. ماژول‌های Hugo (توصیه شده): ساده‌ترین و توصیه‌شده‌ترین روش. ماژول‌های Hugo به شما امکان می‌دهند تم را مستقیماً از منبع آنلاین آن دریافت کنید. تم به صورت خودکار دانلود شده و توسط Hugo مدیریت می‌شود.

  2. زیرماژول Git: به عنوان جایگزین، Hextra را به عنوان یک زیرماژول Git اضافه کنید. تم توسط Git دانلود شده و در پوشه themes پروژه شما ذخیره می‌شود.

راه‌اندازی Hextra به عنوان ماژول Hugo

پیش‌نیازها

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

مراحل

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

hugo new site my-site --format=yaml

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

# راه‌اندازی ماژول Hugo
cd my-site
hugo mod init github.com/username/my-site

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

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

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

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

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

برای جزئیات بیشتر، ماژول‌های Hugo را ببینید.

راه‌اندازی Hextra به عنوان زیرماژول Git

پیش‌نیازها

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

مراحل

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

hugo new site my-site --format=yaml

افزودن تم Hextra به عنوان زیرماژول Git

به دایرکتوری سایت بروید و یک مخزن Git جدید راه‌اندازی کنید:

cd my-site
git init

سپس، تم Hextra را به عنوان زیرماژول Git اضافه کنید:

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

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

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

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

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

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

git submodule update --remote

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

git submodule update --remote themes/hextra

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

بعدی

برای شروع افزودن محتوای بیشتر، بخش‌های زیر را بررسی کنید:

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