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, you then have the possibility to create a component like in the Example and allow 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 and can be checked then.

Quick Setup

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 can get feedback on your documentation ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release