Nuxt Themes

Docus

Docus is the offical Nuxt documentation theme.

Docus offers all the features needed to build a modern looking documentation without efforts.

It is the predecessor of @nuxt/content-theme-docs that used to power the Nuxt 2 modules documentations!

Visit Docus documentation

Features

How to use it ?

Using the starter

npx nuxi init my-docus-project -t docuscd my-docus-projectyarn

Add it to an existing project

  1. Add the theme to your project
yarn add --dev @nuxt-themes/docus
  1. Install it in your Nuxt app
nuxt.config.ts
export default defineNuxtConfig({  extends: ['@nuxt-themes/docus']})

Configure your theme

nuxt.config.ts
import { defineTheme } from '@nuxt-themes/config'export default defineTheme({  title: 'My Documentation Project',  description: 'This documentation is about my awesome package.',  url: 'https://myawesomepackage.dev',  socials: {    twitter: '@nuxt_js',    github: 'nuxt-themes/config'  }})

Start the project

cd my-docus-projectyarn dev✨ Your Docus project is ready!

Deploy it

As any Nuxt 3 project, Docus supports both Node, Edge and Static deployments.

Build a Node server:

nuxi build

Build a static website:

nuxi generate

Who uses it ?

Guide

Options

Themes

Alpine