---

🐰 Introduction

Welcome! This is the repo for Directus' documentation.

Learn more about Directus

🖥️ Running the Docs

Requirements

• Node.js 22
• 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

☁️ 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.