Install Ginko Docs

Ginko Docs is a Nuxt layer. Install it in the consuming app and extend the layer from nuxt.config.ts; you do not copy its pages, layouts, or components into your project.

Requirements

The effective requirements combine the Ginko Docs and Ginko Content package contracts:

The current install command pins the minimum compatible Ginko Content prerelease. The requirements reference records the declared peer ranges and upgrade checks.

Install both Ginko packages in the same command so your package manager can enforce compatible versions:

pnpm add -D @lupinum/ginko-docs@0.3.0-rc.1 @lupinum/ginko-content@0.4.0-rc.1

Use the equivalent development-dependency command when your project uses npm, Yarn, or Bun.

Extend the layer

Add Ginko Docs to the extends array:

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

Keep any other Nuxt layers in the same array. Earlier entries have higher priority, and files in the consuming project override every extended layer. Place a project-specific theme layer before Ginko Docs when it intentionally replaces the shell.

Add the required configuration

An installed layer still needs a content configuration. Create it at the project root:

import { defineGinkoDocsConfig } from "@lupinum/ginko-docs/content";

export default defineGinkoDocsConfig({
  site: {
    name: "Acme Docs",
    description: "Documentation for Acme.",
    url: "https://docs.example.com",
  },
  locales: ["en"],
  blog: false,
});

Then set the visible site identity in app/app.config.ts, as shown in the quickstart. These two public configuration files have different jobs: content.config.ts builds content-derived output, while app config controls the rendered site.

Confirm the installation

Start Nuxt after creating at least one file under content/docs/:

pnpm dev

Nuxt should start without a missing peer warning. Open /docs; Ginko Docs redirects it to the first routable page instead of displaying an empty documentation root.