Skip to content

Configuration

Configure your documentation, landing page, and translations.

On this page

Landing page

Edit content/index.yml to change the landing page title, description, and links. Links beginning with / resolve within the current language.

content/index.yml
title: Documentation for your project
description: Everything you need to get started.
links:
  - label: Get started
    to: /getting-started/introduction

Site identity

Set indocio.name and indocio.description in app/app.config.ts. Replace BrandLogo.vue and public/favicon.svg with your final brand assets.

Translations

By default, i18n is disabled and content lives directly under content/.

Enable i18n in nuxt.config.ts:

nuxt.config.ts
export default defineNuxtConfig({
  extends: ['@igrislabs/indocio'],
  indocio: {
    i18n: { defaultLocale: 'en' },
  },
})

Move your content into content/en/, content/cn/, and content/fr/. Each language has its own index.yml, Markdown pages, and navigation files. Routes use language prefixes, including the default language, such as /en/getting-started/introduction.

Use locale-prefixed links inside translated Markdown, for example /fr/getting-started/configuration. Missing translations return a 404 rather than showing another language.

UI components

IPEX components live in app/components/ui/ and auto-import with the Ui prefix. Documentation components belong in app/components/docs/; globally available Markdown components belong in app/components/content/ or app/components/prose/.

Primary and accent

Primary controls the brand and primary actions. Secondary controls stay neutral. Accent is optional and falls back to primary in both color schemes.

Override --primary and --primary-foreground in your application's stylesheet to change the brand. Provide --accent and --accent-foreground only when you want a separate accent. Define .dark values as needed.

Accent appears sparingly in documentation: faint selected backgrounds, small indicators, focus, and link underlines. Reading text, selected labels, and utility buttons remain neutral. An accent override does not recolor primary or secondary actions.

Layout and authoring

Read Layout and configuration for article width, TOC placement, sidebar behavior, visibility, and edit links.

Read Component overrides to customize individual Docs components. Read Multiple products for independent product spaces and scoped search.

Browse Markdown components in the sidebar for individual component pages with rendered examples, source Markdown, props, and slot usage. Callouts documents all callout variants together.

Components are globally available in Markdown. Use kebab-case names, attributes for simple props, and YAML or bound values for structured data. Nested Markdown works inside component slots.

Use the Live customizer to preview theme and layout changes, then copy the settings into your application.

Set navigation.icon in a page's frontmatter to display its sidebar icon:

yaml
navigation:
  icon: tabler:book

The sidebar reads Nuxt Content’s queryCollectionNavigation('docs') tree and preserves its page order. Locale and project scoping only filter that tree; the sidebar does not keep a separate page list or sort it. Nuxt Content discovers pages from their folders and orders them by content stem. The Markdown components folder uses unnumbered filenames for alphabetical ordering. A folder's .navigation.yml supplies its section title; no listing page or manual navigation registry is needed. Use numeric filename prefixes only when a section needs a specific reading order.

Indocio · Built with Nuxt Content, IPEX, and Akaza UI.