شروع کار

Starlight یک تم مستند سازی کامل و پرامکانات(full-featured) است که بر پایه‌ی فریم‌ورک Astro ساخته شده است. این صفحه راهنمای شما برای شروع کار با یک پروژه جدید در startlight است. راهنمای راهنمای دستور عمل های setup را ببینید اگر می خواهید starlight را به یک پروژه‌ی astro که از قبل ساخته اید اضافه کنید

شروع سریع

ایجاد پروژه جدید

ایجاد یک پروژه‌ی Astro + Starlight با اجرای دستورات ذیل در ترمینال‌تان:

npm

npm create astro@latest -- --template starlight

pnpm

pnpm create astro --template starlight

Yarn

yarn create astro --template starlight

این یک پروژه جدید در قالب پوشه با همه‌ی فایل ها و کانفیگ (فایل های تنظیمات) های لازم برای سایتتان ایجاد می‌کند.

در عمل ببینید

Startlight را در مرورگر خود امتحان کنید: باز کردن الگو در ویرایشگر آنلاین StackBlitz.

اجرای سرور توسعه

وقتی به صورت محلی کار می‌کنید, سرور توسعه Astro به شما اجازه می‌دهد پیش‌نمایشی از کارتان را ببینید و همچنین وقتی تغییری ایجاد میکنید به صورت خودکار مرورگرتان رفرش می‌شود.

درون پوشه پروژه تان، دستورات زیر را اجرا کنید تا سرور توسعه شروع به کار کند:

npm

npm run dev

pnpm

pnpm dev

Yarn

yarn dev

این دستور، یک پیام را در ترمینال‌تان لاگ میکند که آدرس URL پیش‌نمایش سایتتان به صورت محلی است. این آدرس را در مرورگرتان باز کنید تا بتوانید سایتتان را ببینید.

اضافه کردن محتوا

Starlight آماده است تا شما محتواهای جدیدتان را بنویسید و یا فایل هایی که از قبل دارید را به آن اضافه کنید.

صفحات جدید را با ایجاد فایل های Markdown در پوشه‌ی src/content/docs/ به پروژه تان اضافه کنید.

درباره‌ی مسیریابی(routing) براساس فایل و پشتیبانی از فایل های MDX و Markdoc در راهنمای “صفحات” بخوانید.

قدم های بعدی

• کانفیگ کردن: درمورد گزینه های عمومی در “شخصی سازی Starlight” بخوانید.
• پیمایش: نوار کناری را با راهنمای “پیمایش نوارکناری” تنظیم کنید.
• کامپوننت ها: کارت های درون‌زاد(built-in), تب ها, و … را در راهنمای “کامپوننت ها” ببینید.
• گسترش: افزونه های جامعی را در کاتالوگ های“پلاگین ها” و “تم ها” ببینید.
• استقرار: کارتان را با راهنمای“استقرار سایتتان” در مستندات Astro منتشر کنید.

به روز رسانی Starlight

نکته

از آنجایی که Starlight یک نرم افزار بتا هست، تعداد بروزرسانی و توسعه خواهد داشت. مطمئن شود که Starlight را به طور منظم به‌روزرسانی می‌کنید!

Starlight یک توسعه از Astro است. شما می‌توانید این نرم‌افزار و بسته‌های Astro را با اجرای دستورات زیر در ترمینال‌تان به‌روزرسانی کنید:

npm

npx @astrojs/upgrade

pnpm

pnpm dlx @astrojs/upgrade

Yarn

yarn dlx @astrojs/upgrade

به تغییرات Starlight برای دیدن لیست کاملی از تغییراتی که در هر نسخه ایجاد شده، سر بزنید.

اشکال یابی Starlight

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

اگر سوال شما در مستندات حاضر، یافت نمی شود، لطفا مستندات کامل Astro را ببینید. سوال شما شاید با دانستن آنکه Astro به صورت کلی، در لایه های زیرین این تم، چطور کار میکند حل شود.

شما می‌توانید مشکلات Starlight در GitHub را ببینید, و در دیسکورد Astro از جامعه فعال و صمیمی‌مان کمک بگیرید! سوالات خود را در Forum #support با تگ “starlight” بپرسید, یا کانال اختصاصی‌مان #starlight را برای بحث درمورد برنامه نویسی فعلی پروژه و بیشتر ببینید!