Quick Start

ObjectDocs is a modern documentation engine based on Next.js 14 and Fumadocs, supporting the "Configuration as Code" philosophy. This guide will help you quickly set up a new documentation project.

Prerequisites

Ensure your environment meets the following requirements:

• Node.js: 18.17 or higher
• Package Manager: pnpm is recommended (npm or yarn also work)

1. Initialize ObjectDocs

ObjectDocs can be initialized in any existing project or as a new standalone project.

mkdir my-docs
cd my-docs
npm init @objectdocs

cd your-existing-project
npx @objectdocs/cli init

mkdir -p content/docs

2. Add Content

ObjectDocs uses file-system routing. All documentation is stored in the content/docs directory.

---
title: Welcome
description: Your new documentation site
---

# Hello World

Welcome to ObjectDocs! This is your homepage.

{
  "pages": ["index"]
}

{
  "branding": {
    "name": "My Docs"
  },
  "links": [
    {
      "text": "Home",
      "url": "/"
    }
  ]
}

3. Start Development Server

Navigate to the content directory and start the development server:

cd content
npm run dev

The development server will:

• Start on port 7777 (default)
• Watch for changes in content/docs.site.json and automatically restart
• Hot reload your MDX content changes
• Copy public/ assets to the site engine

Now visit http://localhost

Next Steps

• Architecture - Understand ObjectDocs' directory structure and data flow
• Configuration - Learn more about configuration options
• Components - Embed interactive ObjectUI components in your docs