Development Setup

Get the Enddesk blog running locally in under 5 minutes.

Prerequisites

• Node.js 20 or later
• npm 10 or later (comes with Node.js)

Quick Start

# Clone the repository
git clone https://github.com/enddesk/blog.enddesk.com.git
cd blog.enddesk.com

# Install dependencies
npm install

# Start the development server
npm start

The site will be available at http://localhost:3000.

Available Scripts

Command	Description
npm start	Start dev server with hot reload
npm run build	Build production site
npm run serve	Serve production build locally
npm run typecheck	Run TypeScript type checking
npm run clear	Clear Docusaurus cache

Writing a Blog Post

1. Create a new .md or .mdx file in the blog/ directory
2. Add frontmatter with title, authors, and tags
3. Write your content in Markdown or MDX
4. Use <!-- truncate --> to set where the preview cuts off

---
slug: my-new-post
title: My New Blog Post
authors: [enddesk]
tags: [engineering]
---

Your intro paragraph here.

<!-- truncate -->

The rest of your post...

Writing a Guide

1. Create a new .md file in the docs/ directory
2. Add sidebar_position in frontmatter to control ordering
3. Write your guide content

Project Structure

blog.enddesk.com/
├── blog/                # Blog posts (Markdown)
│   ├── authors.yml      # Author definitions
│   └── tags.yml         # Tag definitions
├── docs/                # Guide pages (Markdown)
├── src/
│   ├── components/      # React components
│   ├── css/             # Custom CSS
│   └── pages/           # Custom pages
├── static/              # Static assets
└── docusaurus.config.ts # Site configuration