giscus

یک سیستم نظردهی بر اساس GitHub Discussions. که به کاربران اجازه می دهد دیدگاه ها و بازخوردهای خود را در وب سایت شما به وسیله گیت هاب درج کنند.! این بسیار از سیستم utterances الهام گرفته شده است.

متن باز. 🌏
بدون ترکینگ کد، بدن تبلیغاتو و برای همیشه رایگان. 📡 🚫
بدون نیاز به دیتابیس. تمام دیتاها در سیستم GitHub Discussions نگهداری می شوند.
پیتیبانی از پوسته های سفارشی! 🌗
پشتیبانی از زبان های مختلف. 🌐
قابلیت تنظیمات بالا. 🔧
دریافت خودکار دیدگاه های جدید و ویرایش شده از گیت هاب. 🔃
قابلیت نصب در سرور متعلق به شما! 🤳

توجه
giscus هنوز در حال توسعه فعال است. GitHub همچنین هنوز به طور فعال در حال توسعه Discussions و API آن است. بنابراین، برخی از ویژگی های giscus ممکن است در طول زمان شکسته یا تغییر کند.

نحوه انجام کار

وقتی giscus بارگزاری شد, سیستم GitHub Discussions Search API اقدام به یافتن دیدگاه های مرتبط به صفحه و بر اساس تنظمیات انتخاب شده می کند (URL, pathname, <title>, غیره). اگر یک دیدگاه منطبق پیدا نشد، ربات giscus به طور خودکار یک دیدگاه ایجاد می کند اولین بار که کسی دیدگاه یا واکنشی را ثبت می کند.

برای ثبت دیدگاه به , بازدیدکنندگان باید برنامه giscus دسترسی لازم را بر اساس GitHub OAuth بدهند. یا اینکه, می توانند به طور مستقیم در گیت هاب نظر خود را درج کنند. شما می توانید نظرات را در گیت هاب مدیریت کنید.

پیکربندی

زبان

زبان مورد نظر را انتخاب کنید. اگر زمان مورد نظر شما در لیست نیست، می توانید در اضافه کردن آن مشارکت کنید.

مخزن

مخزنی که giscus به آن متصل خواهد شد را انتخاب کنید. مطمئن شوید که

دسترسی مخزن عمومی باشد, در غیر این صورت بخش دیدگاه‌ها نمایش داده نمی شود.
giscus نصب شده باشد, در غیر این صورت کاربران نمی توانند دیدگاه خود را درج کنند
Discussions در مخزن شما فعال باشد.

مخزن:

یک مخزن عمومی . این مخزن همان جایی است که قصد دارید دیدگاه‌ها در آن نمایش داده شود.

صفحه ↔️ دیدگاه‌ها

یک گزینه برای ارتباط بین صفحه و دیدگاه‌ها انتخاب کنید.

عنوان دیدگاه‌ها شامل pathname باشد

giscus عنوان دیدگاهی را جستجو می کند که شامل pathname در آدرس صفحه باشد.

عنوان دیدگاه‌ها شامل URL باشد

giscus عنوان دیدگاهی را جستجو می کند که شامل URL صفحه باشد.

عنوان دیدگاه‌ها شامل <title> باشد

giscus عنوان دیدگاهی را جستجو می کند که شامل تگ <title> باشد.

عنوان دیدگاه‌ها شامل og:title باشد

giscus عنوان دیدگاهی را جستجو می کند که شامل تگ <meta property="og:title"> باشد.

عنوان دیدگاه‌ها شامل یک عبارت خاص باشد

giscus دیدگاهی را جستجو می کند که شامل یک عنوان خاص باشد.

تعداد دیدگاه‌ها

تعداد مشخصی از دیدگاه‌ها را لود خواهد کرد. این گزینه از ساخت خودکار دیدگاه پشتیبانی نمی کند.

از تطبیق دقیق عنوان استفاده کنید

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

دسته بندی دیدگاه‌ها

دسته بندی ای که قرار است دیدگاه‌های جدید در آن ایجاد شود را انتخاب کنید. بهتر است که از دسته بندی با Announcements استفاده کنید به طوری دیدگاه‌های جدید که دیدگاه‌های جدید فقط توسط نگهدارنده ها و giscus ایجاد می شود.

فقط جستجو در این دسته بندی

وقتی به دنبال یک دیدگاه هستید, giscus فقط در این دسته بندی دنبال آن می گردد.

ویژگی‌ها

انتخاب کنید که آیا ویژگی های خاص باید فعال شوند یا خیر.

فعال کردن بازخوردها برای پست اصلی

بازخوردها پیش از دیدگاه‌ها نمایش داده میشود.

متادیتای دیدگاه‌ها را منتشر کنید.

متادیتای دیدگاه‌ها به صورت دوره ای به پنجره والد ارسال می شود. (the embedding page). برای نمایش آن می توانید این گزینه را فعال و در پنجره کنسول آن را مشاهده کنید. برای اطلاعات بیشتر به این لینک مراجعه کنید.

باکس درج دیدگاه جدید در بالای لیست دیدگاههای قبلی نمایش داده شود

باکس درج دیدگاه جدید در بالای لیست دیدگاه‌ها نمایش داده می شود, در این حالت کاربران نیازی به اسکرول به انتهای دیدگاه‌ها برای درج یک دیدگاه جدید ندارند.

نظرات به صورت lazy load منتشر شود.

بارگزاری دیدگاه تا زمانی که کاربر به بخش دیدگاه‌ها اسکرول نکرده باشد، متوقف خواهد شد. این ویژگی با اضافه کردن loading="lazy" به <iframe> انجام خواهد شد.

پوسته

پوسته مورد نظر را خود انتخاب کنید. اگر پوسته دلخواه خود را نیافتید، می توانید برای ساخت یک پوسته جدید مشارکت کنید.

فعال سازی giscus

این <script> را به پوستهپلیت سایتی که میخواهید نظرات در آن نمایش داده شوداضافه کنید. ولی اگر المانی با کلاس giscus وجود داشته باشد, نظرات در آن نمایش داده خواهد شد.

شما هنوز repository یا category را پیکربندی نکرده اید. مقادیر آن فیلدها تا زمانی که پیکربندی را انجام نداده باشید، نمایش داده نخواهند شد.

<script src="https://giscus.app/client.js"
        data-repo="[مخزن را در اینجا وارد کنید]"
        data-repo-id="[شناسه مخزن را اینجا وارد کنید]"
        data-category="[دسته بندی را اینجا وارد کنید]"
        data-category-id="[شناسه دسته بندی را اینجا وارد کنید]"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="preferred_color_scheme"
        data-lang="fa"
        crossorigin="anonymous"
        async>
</script>

شما میتوانید لی اوت container را از طریق سلکتورهای .giscus و .giscus-frame از embedding page سفارسی کنید

اگر از giscus استفاده می کنید, لطفا به ما در گیت هاب ستاره بدهید 🌟 و موضوع و تاپیک giscus را را به مخزن خود اضافه کنید! 🎉

نکات پیشرفته

شما می توانید تنظیمات پیشرفته (مثل دسترسی به یک آدرس خاص) را از طریق راهنمای پیشرفته استفاده کنید.

برای استفاده از giscus در React, Vue, یا Svelte, این آدرس را ببینید giscus کتابخانه کامپوننت.

مایگریشن

اگر قبلا از سیستمی استفاده می کردید که از GitHub Issues استفاده می کرد مثل (utterances یا gitalk), شما می توانید سیستم فعلی را به discussion گیت هاب تغییر بدهید. پس از تبدیل، فقط مطمئن شوید که نگاشت بین عناوین دیدگاه ها و صفحات صحیح است، سپس giscus به طور خودکار از دیدگاه ها استفاده می کند.

سایت هایی که از giscus استفاده می کنند

مشارکت در کدنویسی

لطفا CONTRIBUTING.md را ببینید