Commentasaurus
Inline feedback, made simple
Abstract
Commentasaurus is a plugin for Docusaurus that enables inline comments within your documentation pages — letting users give direct feedback on specific sections of text, similar to Medium or Google Docs.
Tech Stack
| Layer | Technologies | Description |
|---|---|---|
| Frontend | Docusaurus, TypeScript | Renders the documentation and plugin interface |
| Backend | Go | Handles comment APIs and authentication |
| Storage | GitHub Discussions | Comments are stored using GitHub Discussions for collaboration and transparency |
Getting Started
Folder Structure
.
├── backend/
│ ├── main.go # Golang API entrypoint
│ ├── routes/ # HTTP handlers and routing
│ └── ...
│
├── documentation/
│ ├── docs/ # Markdown documentation about the plugin
│ ├── docusaurus.config.ts # Docusaurus config (plugin settings live here)
│ └── plugins/
│ └── commentasaurus/ # Local path to test the plugin inside Docusaurus
│
└── plugin/
└── src/ # Source code of the plugin to be published to npm
The /plugin directory should mirror the version under /documentation/plugins/commentasaurus to ensure consistency when testing.
Running Locally
Backend (Go API)
cd backend
go run ./cmd/server/main.go
By default, the API runs on http://localhost:8080
There is also a Dockerfile that can be used
Documentation site
cd documentation
npm install
npm run start
This will open http://localhost:3000 for you.
Environment Variables
TODO
Preview
TODO
Contributing
We welcome contributions! Please open issues, submit pull requests, or reach out with suggestions.
- Fork the repo
- Create your branch (
git checkout -b feature/thing) - Commit your changes (
git commit -am 'Add thing') - Push to the branch (
git push origin feature/thing) - Open a pull request
License
This project is licensed under the MIT License. See LICENSE for details.
Collaborators
 Nick Rucinski |