Skip to content

README.md

Latest commit

 

History

History
51 lines (35 loc) · 1.98 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.98 KB
Raw

Nextra example

Sample Nextra docs site (Next.js) with Encatch page feedback in the footer.

Don't have the feedback form yet?

Click the button to install a ready-made documentation feedback form in your Encatch workspace. It creates the combined form used in this example — helpful votes, suggest edits, and issue reports — with no manual form builder setup.

 Encatch it

Setup

pnpm install

Option A — Install the form: use the button above if you need the feedback form created in Encatch.

Option B — Wire this site: In the app you want to run, copy .env.example → .env and set your Encatch publishable key and combined form slug / question slugs (see that app's README for variable names).

Publishable key: admin.encatch.com → Settings → Publishable key.

Run

App Command Docs
Next.js pnpm dev:nextjs http://localhost:3000/en/docs

From the app folder: pnpm dev.

Encatch integration

The app uses the same pattern as fumadocs-examples:

  1. .env — publishable key + combined form slug and question slugs (from .env.example).
  2. lib/encatch.tsx — SDK init, env, and form helpers.
  3. components/docs-page-feedback.tsx — footer UI.
  4. Root layout — <EncatchInit locale={...} />.
  5. Docs page — <DocsPageFeedback pageUrl={...} pageTitle={...} />.

Details: apps/nextjs.

Note

This repo applies a small pnpm patch to nextra-theme-docs@4.6.1 so Layout validates props correctly when children is passed as JSX (upstream issue with LayoutPropsSchema).