docus-feedback

Get Feedback on your Docus based documentation

• ✨ Release Notes
• 🏀 Example

Features

• 💾 SQLite based Storage
• ⛰ Handy composables
• 🗂 TypeScript Support

Quick Introduction

This module is an extension of the documentation theme Docus, this module creates an API endpoint for feedbacks, which enables the possibility to create a component like the Example and allows the user to provide feedback for the documentation articles via the composable that comes with this module.

The feedbacks are stored in an SQLite Database.

Quick Setup

⚠️ This module doesn't support serverless deployment, only Node.JS environment.

1. Add docus-feedback dependency to your project

# Using pnpm
pnpm add -D docus-feedback

# Using yarn
yarn add --dev docus-feedback

# Using npm
npm install --save-dev docus-feedback

2. Add docus-feedback to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["docus-feedback"],
});

That's it! You are now able to get feedback on your documentation pages ✨

Table schema

Module configuration options

Module configuration example

export default defineNuxtConfig({
  modules: ["docus-feedback"],
  feedback: {
    isEnabled: true,
    autoUserTracking: true,
    rateLimiter: {
      throwError: false,
      tokensPerInterval: 150,
      interval: "hour",
      fireImmediately: true,
    },
  }
});

Development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

License

Copyright (c) 2023 Conner Luka Bachmann & Matteo Rezzin MIT License