---

Important

This documentation is in beta. We eagerly welcome your feedback!

🐰 Introduction

Welcome! This is the repo for Directus' documentation.

Learn more about Directus

🖥️ Running the Docs

Requirements

• Node.js 20
• pnpm

Install Dependencies

pnpm install

Run Development Server

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

pnpm dev

☁️ Deploying the Docs

Due to a bug in Nitro, Netlify isn't able to auto-build this website on pushes to main. Instead, a member of the core team has to deploy it manually through the Netlify CLI.

1. netlify env:list --plain – Get a copy of the .env you'll need to build the website
2. pnpm run generate – Build the website locally
3. netlify deploy – This will deploy a staging build to a branch to verify everything looks good. Once that's good to go:
4. netlify deploy --prod – This will then upload the same thing again but push it live to the prod website

🚀 Contributing

• Code of Conduct
• Contributing and authoring guidelines

🤔 Community Help

• Discord (Questions, Live Discussions)
• GitHub Issues (Report Bugs)
• GitHub Discussions (Feature Requests)

© 2004-2024, Monospace, Inc.