@uxfront/docs-theme

@uxfront/docs-theme

A neutral, brandable Nuxt layer documentation theme. Extend it, supply your own branding and content, and get a Docus-shaped docs site — header, footer, sidebar, SEO, i18n routing, OG images and analytics — without copying boilerplate between repos.

The layer ships no product branding. Consuming apps provide title, logos, socials, GitHub, footer, table-of-contents links and colour palette via their own app.config.ts, merged over the layer's neutral defaults by Nuxt's defu layer merge. Site metadata, SEO and git info are auto-inferred from the consumer's package.json + git when not supplied.

Install

npm install -D @uxfront/docs-theme

Then install the peer dependencies the layer expects (the Nuxt documentation stack — see package.json peerDependencies for pinned ranges): nuxt, vue, @nuxt/ui, @nuxt/image, @nuxt/scripts, @nuxtjs/robots, nuxt-og-image, nuxt-llms, tailwindcss, and — for content and translation — @nuxt/content, @nuxtjs/i18n, @nuxtjs/mdc.

Usage

Extend the layer from your app's nuxt.config.ts:

export default defineNuxtConfig({
  extends: ["@uxfront/docs-theme"],
});

Supply your branding from your app's app.config.ts:

export default defineAppConfig({
  header: { title: "My Docs" },
  // logos, socials, footer, toc links, ui.colors …
});

Compatibility

Pinned to the Nuxt 4 documentation stack (Nuxt 4.4, Nuxt UI 4.8, Content 3.14, i18n 10.4, og-image 6, llms 0.2). TypeScript is pinned to the range the Nuxt stack supports (^6.0.3). See peerDependencies for the authoritative ranges.

License

MIT