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 Axiom credentials:

js
window.Do11yConfig = {
  axiomHost: 'AXIOM_DOMAIN',
  axiomToken: 'API_TOKEN',
  axiomDataset: 'DATASET_NAME',
  framework: 'mintlify',
};

Replace AXIOM_DOMAIN, API_TOKEN, and DATASET_NAME with your Axiom credentials.

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

Next steps

Released under the MIT License.