Getting Started
Welcome to DevDocs — the modern documentation platform built for developers who care about quality and speed.
Prerequisites
Before you begin, ensure you have the following installed:
- Node.js 18.x or later
- npm 9.x, pnpm 8.x, or yarn 1.x
- A code editor (we recommend VS Code)
Quick Install
The fastest way to get started is with our CLI tool:
npx create-my-app my-project
cd my-project
npm run dev
Your development server will start at http://localhost:3000.
Manual Setup
1. Create a new project
mkdir my-project && cd my-project
npm init -y
2. Install dependencies
npm install nuxt @nuxt/ui @nuxt/content
3. Create your config file
Create a nuxt.config.ts at the root of your project:
export default defineNuxtConfig({
modules: ['@nuxt/ui', '@nuxt/content'],
})
4. Start the server
npm run dev
Project Structure
my-project/
├── assets/
│ └── css/
│ └── main.css
├── components/
├── content/
│ └── docs/
├── layouts/
│ └── default.vue
├── pages/
│ ├── index.vue
│ └── docs/
│ └── [...slug].vue
├── nuxt.config.ts
└── package.json
Next Steps
- Installation — detailed setup for different environments
- Configuration — all available config options
- Architecture — understand how the system works