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
Download the latest release from GitHub and extract the
do11y-<version>.zipfile.Copy
dist/do11y.min.jsandexamples/do11y-config.example.jsto the same folder in your docs repo (for example,scripts/). Alphabetical ordering ensures the config file loads before the main script.Rename
do11y-config.example.jstodo11y-config.js.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.
- Optional: Set up the automatic sync to keep
do11y.min.jsup to date automatically.