MCPcopy Index your code
hub / github.com/giscus/giscus

github.com/giscus/giscus @main sqlite

repository ↗ · DeepWiki ↗
198 symbols 360 edges 68 files 0 documented · 0%
README

giscus

Система за коментари, базирана на GitHub Discussions. Позволете на посетителите да оставят коментари и реакции на вашия уебсайт чрез GitHub! Силно вдъхновена от utterances.

Забележка giscus все още е в активна разработка. GitHub също активно разработва Discussions и неговото API. Следователно някои функции на giscus може да се променят или да спрат да работят с времето.

Как работи

Когато giscus се зареди, GitHub Discussions API за търсене се използва за намиране на дискусията, свързана със страницата, въз основа на избрано съответствие (URL, pathname, <title> и т.н.). Ако не може да бъде намерена съответстваща дискусия, ботът на giscus автоматично ще създаде дискусия при първия път, когато някой остави коментар или реакция.

За да коментират, посетителите трябва да разрешат на приложението giscus да публикува от тяхно име, използвайки GitHub OAuth процеса. Алтернативно, посетителите могат да коментират директно в GitHub дискусията. Можете да модерирате коментарите в GitHub.

Ако използвате giscus, обмислете да дадете звезда 🌟 на giscus в GitHub и да добавите темата giscus към вашето хранилище! 🎉

Разширена употреба

Можете да добавите допълнителни конфигурации (напр. разрешаване на специфични origins), като следвате ръководството за разширена употреба.

За да използвате giscus с React, Vue или Svelte, вижте библиотеката с компоненти на giscus.

Мигриране

Ако преди сте използвали други системи, които използват GitHub Issues (напр. utterances, gitalk), можете да конвертирате съществуващите issues в дискусии. След конвертирането просто се уверете, че съответствието между заглавията на дискусиите и страниците е правилно, и giscus автоматично ще използва дискусиите.

Сайтове използващи giscus

Допринасяне

Вижте CONTRIBUTING.md


Това README е достъпно на:

Powered by Vercel

Extension points exported contracts — how you extend this code

ICommentProps (Interface)
(no doc)
components/Comment.tsx
CommentBoxProps (Interface)
(no doc)
components/CommentBox.tsx
IWidgetProps (Interface)
(no doc)
components/Widget.tsx
IDirectConfig (Interface)
(no doc)
components/Configuration.tsx
IGiscusProps (Interface)
(no doc)
components/Giscus.tsx
IReactButtonsProps (Interface)
(no doc)
components/ReactButtons.tsx
IReplyProps (Interface)
(no doc)
components/Reply.tsx
IAuthContext (Interface)
(no doc)
lib/context.ts

Core symbols most depended-on inside this repo

useGiscusTranslation
called by 8
lib/i18n.tsx
format
called by 6
lib/i18n.tsx
formatError
called by 5
client.ts
getAppAccessToken
called by 5
services/github/getAppAccessToken.ts
emitData
called by 4
lib/messages.ts
shouldRevalidate
called by 4
services/giscus/discussions.ts
getMetaContent
called by 3
client.ts
adaptReactionGroups
called by 3
lib/adapter.ts

Shape

Function 121
Interface 69
Class 4
Method 4

Languages

TypeScript100%

Modules by API surface

lib/utils.ts13 symbols
lib/i18n.tsx13 symbols
lib/types/github.ts10 symbols
lib/types/giscus.ts10 symbols
lib/types/adapter.ts8 symbols
lib/hooks.ts8 symbols
lib/adapter.ts8 symbols
components/Configuration.tsx6 symbols
services/github/getDiscussion.ts5 symbols
lib/fetcher.ts5 symbols
lib/context.ts5 symbols
services/github/toggleUpvote.ts4 symbols

Dependencies from manifests, versioned

@next/bundle-analyzer12.3.4 · 1×
@primer/octicons-react19.14.0 · 1×
@types/dompurify3.2.0 · 1×
@types/node22.10.2 · 1×
@types/react18.0.9 · 1×
@typescript-eslint/eslint-plugin8.18.2 · 1×
@valkey/valkey-glide2.4.0 · 1×
autoprefixer10.4.20 · 1×
cssnano7.0.6 · 1×
dompurify3.2.3 · 1×
eslint8.57.0 · 1×

For agents

$ claude mcp add giscus \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact