---

🐰 Introduction

Welcome! This is the repo for Directus' documentation.

Learn more about Directus

🖥️ Running the Docs

Requirements

• Node.js 22.18 or later
• pnpm

Install Dependencies

pnpm install

Setup Environment

Copy the example environment file:

cp .env.example .env

Update the environment variables in the .env file with proper secret keys for the different services.

Run Development Server

Start the development server on http://localhost:3000:

pnpm dev

Building Locally

pnpm build

Repository Tooling

The repository includes scripts that keep docs routes stable when files move.

pnpm stable-ids:ensure  # Add missing stableId frontmatter
pnpm stable-ids:check   # Validate stableId frontmatter
pnpm redirects:sync     # Update redirects.json for moved pages
pnpm redirects:check    # Check redirect coverage without writing files
pnpm typecheck:scripts  # Type check repository scripts

pnpm install configures .githooks for the repository when no custom core.hooksPath is set. The pre-commit hook can add missing stableId values to staged docs files. The pre-push hook checks redirects when docs content, redirect configuration, or content configuration changes.

✍️ Authoring Content

Pages live as Markdown files under content/. Frontmatter fields are validated by the schema in content.config.ts.

Framework Guides

Framework guides live under content/frameworks/<framework>/. The numeric prefix on filenames (01., 02., …) controls sidebar sort order only — it has no semantic meaning, renumber freely.

The section frontmatter field controls grouping on the /frameworks/<framework> hub page:

• section: start-here — appears in the "Start Here" block at the top.
• section: guides (or unset) — appears in the "Guides" block below.

Minimal frontmatter for a new framework guide:

---
title: Fetch Data from Directus with Foo
description: Learn how to integrate Directus in your Foo app.
section: start-here
technologies:
  - foo
navigation:
  title: Data Fetching
---

☁️ Deploying the Docs

The documentation automatically deploys to Vercel when changes are merged into the main branch. Simply:

1. Open a Pull Request with your changes
2. This should trigger a deploy preview as well.
3. Once PR is approved and merged to main, Vercel will automatically build and deploy the updated documentation

🚀 Contributing

• Code of Conduct
• Contributing and authoring guidelines

🤔 Community Help

• Community Platform (Questions, Live Discussions)
• GitHub Issues (Report Bugs)
• Roadmap (Roadmap & Feature Requests)

Making changes to Algolia Search

The docs make use of the Algolia Crawler to index the content. The crawler is found at the bottom left in the Algolia dashboard under Data Sources > Crawler > directus. To make changes on how the crawler works, go to the Editor tab and make your changes. By default the crawler runs once a day but you can also manually run it. In order to tweak the ranking of search results, go to the Search > Configure > Index > Configuration > Ranking and Sorting tab.

© 2004-2024, Monospace, Inc.