DeployEasy
← All documentation

DeployEasy Docs

Getting started with DeployEasy

Learn the project structure and the workflow for writing, previewing, and publishing content.

Updated 7/10/2026

DeployEasy is built with Astro, so most of the website is generated as static HTML: it loads quickly, is easy to cache, and is simple to deploy.

Run the project locally

You need a current Node.js LTS release. After cloning the repository, run:

npm install
npm run dev

Astro starts the development server at http://localhost:4321 and updates the page when source content changes.

Write a new document

Create a Markdown or MDX file in src/locales/en/content/docs. Each document has frontmatter like this:

---
title: Deploy your first application
description: Move a sample application to production.
order: 3
---

The filename becomes the URL. For example, deploy-vercel.mdx is published at /en/docs/deploy-vercel.

Check before publishing

npm run build
npm run preview

The build checks TypeScript, generates the static website, and creates the Pagefind search index.