@giscusgiscus

giscus

Hệ thống bình luận được cung cấp bởi GitHub Discussions. Hãy để mọi người truy cập để lại bình luận và reactions trên website của bạn thông qua GitHub! Truyền cảm hứng bởi utterances.

Chú thích:
giscus vẫn đang được phát triển tích cực. GitHub cũng vẫn đang tích cực phát triển Discussions và API của nó. Do đó, một số tính năng của giscus có thể bị lỗi hoặc thay đổi theo thời gian.

Cách mà Giscus hoạt động

Khi giscus loads, GitHub Discussions tìm kiếm API được sử dùng để tìm Discussion được liên kết với trang dựa trên mapping đã chọn(URL, pathname, <title>, v.v..). Nếu không tìm thấy discussion phù hợp, bot giscus sẽ tự động tạo discussion vào lần đầu tiên ai đó để lại bình luận hoặc reaction.

Để mà bình luận, người muốn bình luận phải authorize cho giscus app thành đăng trên danh nghĩa của họ sử dụng luồng OAuth của GitHub. Ngoài ra, khách truy cập có thể nhận xét trực tiếp trên Discussion GitHub. Bạn có thể kiểm duyệt các bình luận trên GitHub.

Cấu hình

Ngôn ngữ

Chọn ngôn ngữ giscus sẽ được hiển thị. Bạn không thể tìm thấy ngôn ngữ của mình? Đóng góp dữ liệu dịch.

Repository

Chọn Repository mà giscus sẽ kết nối. Đảm bảo rằng:

  1. Repository ở chế độ công khai, nếu không khách truy cập sẽ không thể xem discussion github.
  2. Ứng dụng giscus đã được cài đặt, nếu không khách truy cập sẽ không thể comment và reaction.
  3. Tính năng Discussions feature đã được bật bằng cách bật tính năng này cho Repository của bạn .

Kho Repository GitHub công khai. Repo này là nơi các discussions sẽ được liên kết.

Trang ↔️ Discussions Mapping

Chọn mapping giữa trang nhúng và discussion được nhúng.

giscus sẽ tìm kiếm một discussion có tiêu đề chứa thành phần URL tên đường dẫn của trang.

giscus sẽ tìm kiếm discussion dựa trên tiêu đề chứa URL của trang

giscus sẽ tìm kiếm discussion dựa trên tiêu đề chứa <title> HTML tag của trang.

giscus sẽ tìm kiếm discussion dựa trên tiêu đề chứa <meta property="og:title"> HTML tag của trang.

giscus sẽ tìm kiếm một discussion có tiêu đề chứa một cụm từ cụ thể.

giscus sẽ tải một discussion cụ thể theo số. Tùy chọn này không hỗ trợ tạo discussion tự động.

Tránh không khớp do phương pháp tìm kiếm mờ nhạt của GitHub khi có nhiều thảo luận với các tiêu đề tương tự. Xem tài liệu để biết thêm chi tiết.

Thể loại discussion

Chọn thể loại discussion nơi các cuộc thảo luận mới sẽ được tạo. Bạn nên sử dụng thể loại Announcements để chỉ những người bảo trì và giscus mới có thể tạo các cuộc thảo luận mới.

Khi tìm kiếm một discussion phù hợp, giscus sẽ chỉ tìm kiếm trong thể loại này.

Tính năng

Chọn xem có nên bật các tính năng cụ thể hay không.

Reactions cho bài đăng chính của discussion sẽ được hiển thị trước phần bình luận.

Discussion metadata sẽ được gửi định kỳ đến cửa sổ chính (trang nhúng). Để kiểm tra, hãy bật tùy chọn này và mở bảng điều khiển trình duyệt của bạn trên trang này. Xem tài liệu để biết thêm chi tiết.

Trường nhập bình luận sẽ được đặt phía trên bình luận để người dùng có thể để lại bình luận mà không cần phải cuộn đến cuối cuộc thảo luận.

Việc tải nhận xét sẽ bị hoãn lại cho đến khi người dùng cuộn đến gần vùng chứa nhận xét. Điều này được thực hiện bằng cách thêm loading="lazy" vào phần tử <iframe>.

Chủ đề

Chọn một chủ đề phù hợp với trang website của bạn. Không thể tìm thấy một trong đó không? Đóng góp một chủ đề mới.

Bật giscus

Thêm thẻ <script> sau vào website của bạn nơi bạn muốn comment xuất hiện. Nếu một phần tử có class giscus tồn tại, các comment sẽ được đặt ở đó.

Bạn chưa định cấu hình Repository và/hoặc thể loại của mình. Các giá trị cho các trường đó sẽ không được hiển thị cho đến khi bạn điền vào.
<script src="https://giscus.app/client.js"
        data-repo="[NHẬP REPO TẠI ĐÂY]"
        data-repo-id="[NHẬP ID REPO TẠI ĐÂY]"
        data-category="[NHẬP TÊN THỂ LOẠI TẠI ĐÂY]"
        data-category-id="[NHẬP ID THỂ LOẠI TẠI ĐÂY]"
        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="vi"
        crossorigin="anonymous"
        async>
</script>

Bạn có thể tùy chỉnh bố cục container bằng cách sử dụng các bộ chọn .giscus và .giscus-frame từ trang nhúng.

Nếu bạn đang sử dụng giscus, hãy cân nhắc tặng 🌟 giscus trên GitHub và thêm giscus topic đến repository của bạn! 🎉

Cách sử dụng nâng cao

Bạn có thể thêm các cài đặt bổ sung (ví dụ: allowing specific origins) bằng cách làm theo hướng dẫn sử dụng nâng cao.

Để sử dụng giscus với React, Vue hoặc Svelte, hãy xem ở đây Thư viện giscus component.

Migrating

Nếu trước đây bạn đã sử dụng các hệ thống khác sử dụng GitHub Issues(ví dụ như: utterances, gitalk), Bạn có thể chuyển đổi các issues hiện có thành discussions. Sau khi chuyển đổi, chỉ cần đảm bảo rằng việc mapping giữa các tiêu đề discussion và các trang là chính xác, sau đó giscus sẽ tự động sử dụng các discussion.

Các website sử dụng giscus

Contributing

Xem CONTRIBUTING.md

Hãy dùng thử 👇👇👇

Powered by Vercel