v3.2 Released — AI-Powered Search is here

Documentation that
developers love

Build beautiful, intelligent documentation experiences. NexDocs combines powerful APIs, stunning design, and developer-first workflows.

Popular Articles

Most viewed documentation this week

Built for developers

Clean, intuitive APIs that just work

install.sh 
# Install the NexDocs SDK
npm install @nexdocs/sdk

# Or use yarn
yarn add @nexdocs/sdk

# Or use pnpm
pnpm add @nexdocs/sdk
app.js 
import { NexDocs } from '@nexdocs/sdk';

const docs = new NexDocs({
  apiKey: 'ndx_live_xxxxxxxx',
  project: 'my-project',
  theme: 'auto'
});

await docs.deploy();
// ✨ Your docs are live!

50K+

Documentation Pages

200+

API Endpoints

99.9%

Uptime SLA

10ms

Avg Response Time

SDKs & Libraries

Official libraries for your favorite language

Guide Updated Dec 15, 2025 • 8 min read

Getting Started with NexDocs

Welcome to NexDocs! This guide will walk you through setting up your first documentation project, configuring your environment, and deploying your docs to production.

Before you begin

Make sure you have Node.js 18+ and npm 9+ installed on your machine. You'll also need a NexDocs account — sign up for free.

Installation

Install the NexDocs CLI globally to get started. The CLI provides commands for initializing projects, local development, and deployment.

Terminal 
npm install -g @nexdocs/cli

Initialize a Project

Create a new documentation project using the nexdocs init command. This will set up the project structure with sensible defaults.

Terminal 
# Create a new project
nexdocs init my-docs

# Navigate to the project
cd my-docs

# Start the dev server
nexdocs dev

Configuration

Configure your project by editing the nexdocs.config.js file in your project root.

nexdocs.config.js 
export default {
  name: 'My Documentation',
  description: 'Official docs for my project',
  theme: {
    primaryColor: '#6366f1',
    darkMode: true,
    font: 'Inter'
  },
  navigation: {
    logo: './assets/logo.svg',
    links: [
      { title: 'Docs', href: '/docs' },
      { title: 'API', href: '/api' },
      { title: 'Blog', href: '/blog' }
    ]
  },
  search: {
    provider: 'algolia',
    indexName: 'my-docs'
  }
};

Important

Never commit your API keys to version control. Use environment variables or a .env file instead.

Deployment

Deploy your documentation to NexDocs Cloud with a single command. Your docs will be available at your-project.nexdocs.dev.

Terminal 
# Deploy to production
nexdocs deploy --production

# Deploy to staging
nexdocs deploy --preview

# Output:
# ✓ Build completed (2.1s)
# ✓ Uploaded 47 pages
# ✓ CDN invalidated
# ✓ Live at https://my-docs.nexdocs.dev

You're all set!

Your documentation is now live. Continue to the next section to learn about customization, or explore the API reference.

Next Steps

Was this page helpful?

Thanks for your feedback!

API Reference

Complete reference for the NexDocs REST API. All endpoints accept and return JSON.

Base URL: https://api.nexdocs.dev/v1
Version 3.2

Authentication

Manage API keys, tokens, and authentication flows

Users

Create, read, update, and delete user accounts

Documents

Manage documentation pages and content

Search

Full-text search across documentation

POST /v1/users

Create a User

Creates a new user account with the specified attributes. Returns the created user object on success.

Request Body

Parameter Type Required Description
email string Yes User's email address
name string Yes Full name
role enum No admin, editor, viewer
metadata object No Custom key-value pairs

Response

200 User created successfully
400 Invalid request body
409 User already exists
Request 
curl -X POST https://api.nexdocs.dev/v1/users \
  -H "Authorization: Bearer ndx_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "name": "Jane Smith",
    "role": "editor"
  }'
const response = await fetch('https://api.nexdocs.dev/v1/users', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'jane@example.com',
    name: 'Jane Smith',
    role: 'editor'
  })
});

const user = await response.json();
import requests

response = requests.post(
    'https://api.nexdocs.dev/v1/users',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'email': 'jane@example.com',
        'name': 'Jane Smith',
        'role': 'editor'
    }
)

user = response.json()
package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func createUser() {
    body, _ := json.Marshal(map[string]string{
        "email": "jane@example.com",
        "name":  "Jane Smith",
        "role":  "editor",
    })

    req, _ := http.NewRequest(
        "POST",
        "https://api.nexdocs.dev/v1/users",
        bytes.NewBuffer(body),
    )
    req.Header.Set("Authorization", "Bearer "+apiKey)
}
Response 200 OK 
{
  "id": "usr_abc123def456",
  "email": "jane@example.com",
  "name": "Jane Smith",
  "role": "editor",
  "created_at": "2025-12-15T10:30:00Z",
  "updated_at": "2025-12-15T10:30:00Z",
  "metadata": {}
}

Tutorials

Hands-on, step-by-step tutorials to help you build real-world applications with NexDocs.

Beginner 45 min • Updated Jan 5, 2026

Build a REST API with NexDocs

Learn how to create a fully functional REST API with authentication, CRUD operations, and automatic documentation generation.

Step 1: Project Setup

First, let's initialize a new NexDocs API project. This will create the project scaffolding with all the necessary configurations.

Terminal 
# Create a new API project
nexdocs create-api my-api --template rest

# Install dependencies
cd my-api && npm install

# Start development server
npm run dev

This creates a project structure with the following files:

📁 my-api/

├── 📄 nexdocs.config.js

├── 📄 package.json

├── 📁 src/

│ ├── 📄 index.js

│ ├── 📁 routes/

│ ├── 📁 models/

│ └── 📁 middleware/

├── 📁 docs/

└── 📁 tests/

Knowledge Base

Find answers organized by topic. Browse categories or search for specific questions.

Account & Billing

12 articles in this category

How can we help?

Search our help center or browse categories below

Getting Started

Setup and first steps

Security

Authentication & permissions

Billing

Plans, invoices & payments

Technical

APIs, SDKs & integrations

Frequently Asked Questions

Still need help?

Our support team is available 24/7 to assist you.

Changelog

All the latest updates, improvements, and fixes to NexDocs.

v3.2.0 Major Release

AI-Powered Search & New SDK

Released December 10, 2025

We're excited to announce NexDocs v3.2 — our biggest release yet. This update introduces AI-powered semantic search, a completely redesigned SDK, and dozens of improvements.

✨ New Features

  • ● AI-Powered Search — Semantic search that understands natural language queries and returns contextually relevant results.
  • ● SDK v3 — Completely rewritten with TypeScript, tree-shaking support, and 60% smaller bundle size.
  • ● Real-time Collaboration — Multiple authors can edit documentation simultaneously with conflict resolution.

🐛 Bug Fixes

  • ● Fixed sidebar navigation not highlighting the active page on mobile devices
  • ● Resolved code block copy button not working in Safari 17+
  • ● Fixed search indexing delay for newly published pages

Search Results

Showing 12 results for "authentication"

Simple, transparent pricing

Start free, scale as you grow. No hidden fees, no surprises.

Monthly Annual Save 20%

Contact Us

We'd love to hear from you. Send us a message and we'll respond as soon as possible.

Email

support@nexdocs.dev

Live Chat

Available Mon-Fri, 9am-6pm EST

Office

San Francisco, CA

✓ Message sent successfully! We'll get back to you within 24 hours.
404

Page not found

The page you're looking for doesn't exist or has been moved.

Popular pages: