د س ک ی

مستندات

مقالات، راهنما و توصیه‌هایی را بیابید تا از تم دسکی حداکثر استفاده را ببرید

نصب و راه اندازی

نصب دسکی

Deski از ابتدا طراحی شده است تا به راحتی نصب شود و از آن برای راه اندازی سریع وب سایت شما استفاده شود.

npm i deski-cli-g

تایید نصب

اگر می‌خواهید مستندات را در فهرست فرعی ./docs بنویسید، می‌توانید از دستور init استفاده کنید.

deski init./docs

اگر هیچ پروژه ای وجود ندارد، یک پروژه ایجاد کنید و دایرکتوری خود را به ریشه این پروژه تغییر دهید.

شما اسناد را در این فهرست ایجاد خواهید کرد. دایرکتوری ریشه ممکن است حاوی فایل های دیگری باشد. اسکریپت نصب Docusaurus دو دایرکتوری جدید ایجاد می کند: docs و website

. 
شما باید در Node >= 10.9.0 و Yarn >= 1.5 باشید.
اگر Node 1.8.2+ را ندارید یا ترجیح می دهید deski را به صورت سراسری نصب کنید، yarn global add deski-init یا npm نصب --global deski-init. پس از آن، docusaurus-init را اجرا کنید.

نصب دستی

اگر npm را دوست ندارید یا در نصب ابزار مشکل دارید، می توانید به صورت دستی index.html ایجاد کنید:

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta charset="UTF-8">
    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css">
</head>
<body>
    <div id="app">
    </div>
    <script>
        window.$docsify = {
        //....
        }
    </script>
    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>
							
توجه داشته باشید که در هر دو مثال زیر، آدرس‌های اینترنتی docsify باید به‌صورت دستی به‌روزرسانی شوند که نسخه جدیدی از deski منتشر شود (به عنوان مثال v4.x.x => v5.x.x ). وب سایت docsify را به صورت دوره ای بررسی کنید تا ببینید آیا نسخه اصلی جدید منتشر شده است.

اجرای وب سایت آزمایشی

پس از اجرای اسکریپت اولیه سازی Deski، docusaurus-init همانطور که در بخش نصب توضیح داده شد، یک وب سایت نمونه قابل اجرا خواهید داشت که می توانید از آن به عنوان پایگاه سایت خود استفاده کنید. برای اجرا:

  • می تواند یک شناسه داشته باشد که یک عدد یا یک رشته است.
  • اگر درست باشد، نوار ناوبری را از فایل Markdown _navbar.md بارگیری می کند، در غیر این صورت آن را از مسیر مشخص شده بارگیری می کند.
  • اگر سایت نمونه به طور خودکار باز نشده است، در http://localhost:3000 بارگیری کنید. اگر پورت 3000 قبلاً گرفته شده باشد، درگاه دیگری استفاده خواهد شد. به پیام های کنسول نگاه کنید تا ببینید کدام

راه اندازی سرور

اگر پشت پراکسی شرکتی هستید، باید آن را برای درخواست‌های سرور توسعه غیرفعال کنید. می تواند از متغیر محیطی NO_PROXY استفاده کند.

window.$deski = { 
 name: '<span>deski</span>', 
};

دیالوگ لودینگ

<!-- index.html --> 

<div id="app">Please wait...</div>

اگر el را تغییر دادید، باید ویژگی data-app را تنظیم کنید:

<!-- index.html --> 

<div data-app id="main">Please wait...</div> 
<script>
    window.$docsify = {
    el: '#main'
    }
</script>

شما می توانید به آخرین نسخه Docusaurus به روز رسانی کنید:

yarn upgrade deski --latest
  •     شروع سریع
  • اماده سازی سایت