Nuxt UI

Docus

Preview
Write beautiful docs with Markdown

A beautiful, minimal starter for creating documentation with Docus

This is the default Docus starter template that provides everything you need to build beautiful documentation sites with Markdown and Vue components.

✨ Features

  • 🎨 Beautiful Design - Clean, modern documentation theme
  • πŸ“± Responsive - Mobile-first responsive design
  • πŸŒ™ Dark Mode - Built-in dark/light mode support
  • πŸ” Search - Full-text search functionality
  • πŸ“ Markdown Enhanced - Extended markdown with custom components
  • 🎨 Customizable - Easy theming and brand customization
  • ⚑ Fast - Optimized for performance with Nuxt 4
  • πŸ”§ TypeScript - Full TypeScript support

πŸš€ Quick Start

# Install dependencies
npm install

# Start development server
npm run dev

Your documentation site will be running at http://localhost:3000

πŸ“ Project Structure

my-docs/
β”œβ”€β”€ content/              # Your markdown content
β”‚   β”œβ”€β”€ index.md         # Homepage
β”‚   β”œβ”€β”€ 1.getting-started/  # Getting started section
β”‚   └── 2.essentials/    # Essential documentation
β”œβ”€β”€ public/              # Static assets
└── package.json         # Dependencies and scripts

⚑ Built with

This starter comes pre-configured with:

πŸ“– Documentation

For detailed documentation on customizing your Docus project, visit the Docus Documentation

πŸš€ Deployment

Build for production:

npm run build

The built files will be in the .output directory, ready for deployment to any hosting provider that supports Node.js.

πŸ“„ License

MIT License

Features