Skip to main content

Publish documentation from Markdown.

Add routed docs, search, English and German localization, SEO, and agent-readable output to a Nuxt 4 app.

pnpm add -D @lupinum/ginko-docs@0.3.0-rc.1 @lupinum/ginko-content@0.4.0-rc.1
export default defineAppConfig({
  ginkoDocs: {
    site: {
      name: { en: "My Docs" },
      docsSidebarSwitcher: "tabs",
    },
    nav: { links: "auto" },
    analytics: {
      plausible: { scriptId: "ExampleSiteScriptId" },
    },
  },
});

33 canonical tags

Use callouts, steps, tabs, code groups, file trees, timelines, quizzes, and media in Markdown.

Search built in

⌘K command center with active-locale navigation and full-text content results.

English and German routes

Pair translated documents while keeping public slugs, navigation, and locale fallback aligned.

SEO & OG images

Generated social cards, sitemap, robots, and canonical links out of the box.

Dark mode & theming

Dual-theme code highlighting and design tokens that adapt to both color schemes.

Repository links

Give every documentation page direct edit and issue links from the configured GitHub repository.

Your docs, readable by agents

Raw Markdown and LLM catalogs work on every deployment. Nitro servers also add content negotiation and read-only MCP tools.

$ curl https://docs.example.com/raw/docs/setup.md# SetupInstall the layer and publish the first page.$ curl https://docs.example.com/llms.txt# Ginko Docs> Documentation for the Ginko Docs Nuxt layer.

Start with one Markdown page.