Skip to content

README.md

Latest commit

 

History

History
71 lines (48 loc) · 1.46 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.46 KB

@giscus/react

Type-safe React component for giscus 💎

giscus is a lightweight comments widget built on GitHub issues, for blog comments, wiki pages and more.

✨ Features

  • 📚 Pure TypeScript and TSX with type definitions
  • 🌎 Multiple modules, providing ES modules and CommonJS

⚡ Quick view

Follow the instructions on the main website and use the data attributes of the shown <script> tag as the props to the Giscus component.

import { Giscus } from '@giscus/react';

...

<Giscus
  repo="..."
  repoId="..."
  category="..."
  categoryId="..."
  mapping="..."
  term="..."
  reactionsEnabled="..."
  emitMetadata="..."
  theme="..."
/>

💫 Install

📦 Node.js

npm i @giscus/react
# or
yarn add @giscus/react

🌐 Browser

The module that bundles the dependencies is obtained from skypack.

Import it like this:

import { Giscus } from 'https://cdn.skypack.dev/@giscus/react'

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check out the repository.

🌱 Show your support

Give a ⭐️ if this project helped you!

💡 License

Copyright © 2021-present TomokiMiyauci, forked by laymonage for giscus.

Released under the MIT license.