Introduction

Welcome to the Docd documentation.

What is Docd?

Docd is a Nuxt Layer that you can extend to create documentation websites.

It combines Nuxt Content for authoring and UI Thing components for the documentation interface.

What Docd focuses on

Docd is built around a few practical defaults:

  • Content-first documentation with file-based routing
  • A Markdown and MDC authoring workflow
  • Reusable prose components for rich docs content
  • Layer-based composition so consumers can still use normal Nuxt files
  • Sensible SEO defaults for docs pages and landing pages
  • A docs UI that is easy to extend instead of hard to override

Credits

Nuxt for the application framework

Nuxt Content for the content authoring experience

Docus for design inspiration & functionality ideas

UI Thing for the component library and design system foundations

Shadcn Docs for the idea of a Nuxt-based docs starter layer

Core pieces

Reusable Nuxt Layer

Docd ships as a Nuxt layer so documentation features can be shared across projects.

Nuxt Content + MDC

Write docs in Markdown, then reach for MDC components when plain Markdown is not enough.

UI Thing Components

The interface is built with UI Thing primitives and custom prose components tailored for docs.

Starter CLI

Use create-docd to bootstrap a new project from the default starter template.

Key features

Docd currently gives you a strong base for shipping documentation:

  • Nuxt as the application foundation
  • Nuxt Content collections for landing pages and docs pages
  • Optional /docs routing when content is organized in a docs/ subfolder
  • A custom landing-page flow that can be replaced with your own app/pages/index.vue
  • Auto-generated navigation from your content structure
  • Built-in prose components for cards, callouts, tabs, code blocks, fields, and more
  • Search UI, table of contents support, and theme customization hooks
  • SEO helpers for metadata, breadcrumbs, canonical URLs, and OG images

How to think about it

If you are building with Docd, the main idea is simple:

  1. Write content in content/
  2. Extend the layer from nuxt.config.ts
  3. Override or add normal Nuxt files whenever you need to customize behavior

Docd is opinionated about documentation workflows, but it is still just Nuxt underneath.