Skip to content
DotDive — VitePress مبتنی بر SEO برای اسناد استاتیک
DotDive یک پلتفرم اسناد بهینه‌شده مبتنی بر VitePress است که HTML استاتیک دوست‌دار SEO تولید می‌کند، عملکرد را بهبود می‌بخشد و یک لوله محتوای ایمن از نظر نوع فراهم می‌کند تا توسعه‌دهندگان بتوانند اسناد با کیفیت بالا را نوشته، تصدیق‌کرده و منتشر کنند یا آن‌ها را در سایر پروژه‌ها ادغام کنند.
مزایای کلیدی
- HTML استاتیک مبتنی بر SEO: صفحات معنایی و قابل‌کاوش با عنوان‌های منحصر به فرد، توضیح‌های فراداده، URLهای کانونیکی، کارت‌های Open Graph/Twitter و JSON-LD (Article + Breadcrumb) که از frontmatter تولید می‌شوند.
- لوله محتوای ایمن از نظر نوع: Markdown + frontmatter به اشیاء
DocPageمایل تجزیه می‌شوند با تصدیق برای گرفتن مسائل فراداده یا ساختار در زمان ساخت. - عملکرد بهینه‌شده: سرور توسعه مبتنی بر Vite، صفحات از پیش رندر‌شده، دارایی‌های بهینه‌شده، بارگذاری تنبل و بسته‌های هسته‌ای کوچک برای بهبود Core Web Vitals.
- ابزارسازی دوست‌دار برنامه‌نویس: کمک‌دهندگان، تصدیق‌کنندگان و آزمایش‌ها متمرکز به دنبال بهترین روش‌های SEO و نگه‌داری صحیح محتوا را آسان می‌کنند.
- استقرار آماده‌ی Docker: یک
Dockerfileآماده‌ی تولید برای ساخت و استقرار‌های کانتینری شامل است.
چگونه کار می‌کند
- یک فایل Markdown را با frontmatter YAML بنویسید (برای زمینه‌های مورد نیاز
config_review.mdرا ببینید). - بارگذار محتوا
docs/،services/و دایرکتوری‌های پیکربندی‌شده را اسکن می‌کند تا اشیاءDocPageمایل بسازد. - مولد برچسب‌های head، فراداده‌های Open Graph/Twitter و طرح‌های JSON-LD را محاسبه می‌کند تا اشیاء
RenderedDocPageتولید کند. - رندرکننده‌ی استاتیک صفحات HTML از پیش رندر‌شده را با فراداده‌های
<head>صحیح و داده‌های ساختاربندی‌شده خروجی می‌دهد.
الزامات SEO و محتوا
- frontmatter مورد نیاز شامل
layout،type،title،description،category،order،author،publishedAt،updatedAtوrobotsاست — برای قوانین تصدیقconfig_review.mdرا ببینید. - پیشنهادی:
image/ogImage،canonical،tagsوlangبرای زبان‌های غیرپیشفرض.
گردش‌کار توسعه‌دهنده
- توسعه‌ی محلی:
npm run dev(سرور توسعه‌ی Vite/VitePress) - آزمایش:
npm test(شامل بررسی‌های frontmatter و SEO) - ساخت:
npm run build(خروجی استاتیک، آماده برای Docker) - استقرار: تصویر Docker ارائه‌شده را بسازید یا فایل‌های استاتیک را به هر میزبان استاتیک صادر کنید.
کجا صفحات اضافه کنیم
- اسناد را در
docs/و صفحات سرویس را درservices/با ایجاد فایل‌های Markdown با frontmatter اضافه کنید. - صفحات فرود سطح‌بالاتر را می‌توان در ریشه‌ی مخزن یا یک پوشه‌ی پیکربندی‌شده اضافه کرد؛ اطمینان حاصل کنید که پیکربندی سایت یا مسیرهای پلاگین آن‌ها را شامل می‌شوند.