Skip to content

Configuration ​

WCAGify is configured through standard Nuxt configuration files.

Nuxt Config ​

The main configuration file is nuxt.config.ts in the project root.

ts
export default defineNuxtConfig({
  modules: ['@nuxt/content', '@nuxt/ui', '@nuxtjs/i18n']
})

Content Collections ​

Content collections are defined in content.config.ts. WCAGify uses three collections:

CollectionPathDescription
reportscontent/reports/{slug}/index.mdReport metadata
issuescontent/reports/{slug}/*.mdIndividual findings
sharedcontent/shared/{lang}/*.mdShared content blocks

Internationalization ​

Language settings are configured through @nuxtjs/i18n:

SettingValue
Defaulten (English)
Secondarynl (Dutch)
Strategyno_prefix

Translation files live in two layers, which @nuxtjs/i18n merges. The report's own texts are in the report layer, the rest of the app's in the WCAGify layer:

text
packages/wcagify-reporter/locales/   # report, codeBlock
├── en.ts
└── nl.ts
packages/wcagify/locales/            # app, import, share, admin, settings, error
├── en.ts
└── nl.ts

Linting and Formatting ​

ToolCommandConfig file
OXlintpnpm lintoxlint.config.ts
oxfmtpnpm fmt—

Commands Reference ​

CommandDescription
pnpm devStart development server
pnpm buildProduction build
pnpm previewPreview production build
pnpm lintRun OXlint
pnpm typecheckRun type checking
pnpm docs:devStart docs development server
pnpm docs:buildBuild documentation site