Skip to content

Install on Mintlify

Mintlify doesn't support loading scripts from a CDN via config, so Do11y must be self-hosted in your docs repo.

Steps

  1. Download the latest release from GitHub and extract the do11y-<version>.zip file.

  2. Copy dist/do11y.min.js and examples/do11y-config.example.js to the same folder in your docs repo (for example, scripts/). Alphabetical ordering ensures the config file loads before the main script.

  3. Rename do11y-config.example.js to do11y-config.js.

  4. In do11y-config.js, replace the placeholder values with your Supabase credentials:

    js
    window.Do11yConfig = {
      supabaseUrl: 'SUPABASE_PROJECT_URL',
      supabaseKey: 'SUPABASE_PUBLISHABLE_KEY',
      framework: 'mintlify',
    };

    Replace SUPABASE_PROJECT_URL and SUPABASE_PUBLISHABLE_KEY with your Supabase credentials.

  5. Optional: Set up the automatic sync to keep do11y.min.js up to date automatically.

Next steps

Released under the MIT License.