Wiscus
Wiscus is a lightweight WordPress plugin that integrates the Giscus comment system, allowing you to use GitHub Discussions as a modern comment platform for your website.
Instead of storing comments in your WordPress database, Wiscus connects your site to a GitHub repository and uses Discussions to manage conversations. Each post or page can automatically create and link to a corresponding discussion thread.
Key features:
- GitHub-powered comments using Giscus
- Automatic discussion thread creation
- Lightweight and privacy-friendly (no ads, no tracking)
- Easy integration via widget or shortcode
- Customizable themes and mapping options
- Hot page reloading
Development
This plugin uses a build process (webpack) to generate production files located in /build.
The full, human-readable source code is available here: https://github.com/zakarialaoui10/wiscus
Project structure
- /src : original source code
/build: compiled/minified production files (used in production)
Dependencies
This plugin relies on the following external libraries:
- giscus used for embedding GitHub Discussions-based comments system.
- ziko a custom UI/library used for frontend rendering and components.
Getting started
Clone the repository: git clone https://github.com/zakarialaoui10/wiscus.git cd wiscus
Install dependencies: npm install
Run development mode: npm run dev
Build for production: npm run build
Forking & Contributing
You are welcome to fork and contribute:
- Fork the repository on GitHub.
- Clone your fork (replace
<your-username>with your GitHub handle): git clone https://github.com//wiscus.git - Create a new branch: git checkout -b feature/your-feature-name
- Commit your changes and push: git push origin feature/your-feature-name
- Open a Pull Request.
Note: Ensure you are cloning your personal fork and not the main repository if you intend to submit a Pull Request
Notes
- Do not edit files inside /build directly.
- Always make changes in /src and rebuild.