Skip to content

get-encatch/mintlify-examples

Repository files navigation

Mintlify example

Sample Mintlify docs site with Encatch page feedback in the footer.

Setup

Mintlify requires Node LTS (20 or 22). Node 25+ is not supported.

Install the Mintlify CLI:

npm i -g mint

If your default Node is 25+, install Node 22 as well (Homebrew keeps it side by side):

brew install node@22

./docs dev mintlify from the repo root will automatically use Node 22 when needed. For mint dev directly:

PATH="/opt/homebrew/opt/node@22/bin:$PATH" mint dev

Copy encatch-config.example.jsencatch-config.js and set your Encatch publishable key and form slugs.

Publishable key: admin.encatch.comSettingsPublishable key.

Run

mint dev

Open http://localhost:3000 (or the port shown in the terminal).

Encatch integration

This example uses the same pattern as the Fumadocs examples, adapted for Mintlify:

  1. encatch-config.js — publishable key + form slugs (copy from encatch-config.example.js). Must use this filename so Mintlify loads it before encatch-init.js.
  2. encatch-init.js — loads the Encatch SDK from CDN, initializes it, and exposes form helpers on window.EncatchDocs.
  3. snippets/docs-page-feedback.jsx — footer UI (helpful yes/no, suggest edits, raise issue).
  4. Each MDX page — imports <DocsPageFeedback locale="..." /> at the bottom of the page.

Mintlify site configuration (navigation, theme, i18n) lives in docs.json. Mintlify auto-includes .js files in the project root on every page.

Pages

Language Pages
English /index, /docs-feedback
Spanish /es/index, /es/docs-feedback

Use the language switcher in the navbar to switch between English and Spanish.

About

Mintlify documentation example with Encatch page feedback

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors