jigsaw docs template

قالب بدء تشغيل مستندات Jigsaw

يعد هذا نموذجًا أوليًا لإنشاء موقع توثيق جميل وقابل للتخصيص لمشروعك بأقل جهد. كل ما عليك فعله هو تغيير بعض الإعدادات وستكون جاهزًا للبدء.

عرض معاينة لقالب المستندات.

تثبيت

بعد تثبيت Jigsaw، قم بتشغيل الأمر التالي من دليل المشروع الخاص بك:

./vendor/bin/jigsaw init docs

يتضمن قالب البداية هذا نماذج من أنواع الصفحات الشائعة، ويأتي مزودًا بتكوين مسبق:

• شريط تنقل سريع الاستجابة
• قائمة التنقل في الشريط الجانبي
• Tailwind CSS، هو إطار عمل CSS مفيد يسمح لك بتخصيص تصميمك دون لمس أي سطر من CSS
• Purgecss لإزالة المحددات غير المستخدمة من CSS الخاص بك، مما يؤدي إلى ملفات CSS أصغر
• تسليط الضوء على بناء الجملة باستخدام Highlight.js
• برنامج نصي يقوم تلقائيًا بإنشاء ملف sitemap.xml
• شريط بحث مدعوم من Algolia DocSearch، وتعليمات حول كيفية البدء في خدمة الفهرسة المجانية الخاصة بهم
• صفحة 404 مخصصة

---

---

تكوين موقعك الجديد

كما هو الحال مع جميع مواقع Jigsaw، يمكن العثور على إعدادات التكوين في config.php ؛ يمكنك تحديث المتغيرات الموجودة في هذا الملف بإعدادات خاصة بمشروعك. يمكنك أيضًا إضافة متغيرات تكوين جديدة هناك لاستخدامها عبر موقعك؛ قم بإلقاء نظرة على وثائق Jigsaw لمعرفة المزيد.

 // config.php
return [
    ' baseUrl ' => ' https://my-awesome-jigsaw-site.com/ ' ,
    ' production ' => false ,
    ' siteName ' => ' My Site ' ,
    ' siteDescription ' => ' Give your documentation a boost with Jigsaw. ' ,
    ' docsearchApiKey ' => '' ,
    ' docsearchIndexName ' => '' ,
    ' navigation ' => require_once ( ' navigation.php ' ),
];

نصيحة: ملف التكوين هذا هو أيضًا المكان الذي ستحدد فيه أي "مجموعات" (على سبيل المثال، مجموعة من المساهمين في موقعك، أو مجموعة من منشورات المدونة). تحقق من وثائق Jigsaw الرسمية لمعرفة المزيد.

---

إضافة المحتوى

يمكنك كتابة المحتوى الخاص بك باستخدام مجموعة متنوعة من أنواع الملفات. افتراضيًا، يتوقع قالب البداية هذا أن يكون المحتوى الخاص بك موجودًا في مجلد source/docs . إذا قمت بتغيير هذا، فتأكد من تحديث مراجع URL في navigation.php .

يحتوي القسم الأول من كل صفحة محتوى على رأس YAML الذي يحدد كيفية عرضه. يتم استخدام سمة title لإنشاء title HTML وعلامات OpenGraph لكل صفحة ديناميكيًا. تحدد سمة extends تخطيط النصل الأصلي الذي سيتم عرضه باستخدام ملف المحتوى هذا (على سبيل المثال، سيتم عرض _layouts.documentation مع source/_layouts/documentation.blade.php )، وتحدد سمة section "قسم" النصل الذي يتوقع وضع هذا المحتوى فيه.

---
title : Navigation
description : Building a navigation menu for your site
extends : _layouts.documentation
section : content
---

اقرأ المزيد عن تخطيطات Jigsaw.

---

إضافة الأصول

يمكن إضافة أي أصول تحتاج إلى تجميع (مثل ملفات JavaScript أو Less أو Sass) إلى الدليل source/_assets/ ، وسيقوم Laravel Mix بمعالجتها عند تشغيل npm run dev أو npm run prod . سيتم تخزين الأصول المعالجة في /source/assets/build/ (لاحظ أنه لا توجد شرطة سفلية في دليل assets الثاني هذا).

بعد ذلك، عندما يقوم Jigsaw بإنشاء موقعك، سيتم نسخ الدليل /source/assets/ بأكمله الذي يحتوي على ملفاتك المضمنة (وأية أدلة أخرى تحتوي على أصول ثابتة، مثل الصور أو الخطوط، التي تختار تخزينها هناك) إلى مجلدات البناء الوجهة ( build_local ، على جهازك المحلي).

يمكن إضافة الملفات التي لا تتطلب معالجة (مثل الصور والخطوط) مباشرةً إلى /source/assets/ .

اقرأ المزيد عن تجميع الأصول في Jigsaw باستخدام Laravel Mix.

---

بناء موقعك

الآن بعد أن قمت بتحرير متغيرات التكوين الخاصة بك ومعرفة كيفية تخصيص الأنماط والمحتوى الخاص بك، فلنقم ببناء الموقع.

 # build static files with Jigsaw
./vendor/bin/jigsaw build

# compile assets with Laravel Mix
# options: dev, prod
npm run dev