Skip to content
JustDocs

Quick Start

Get your documentation site up and running in just a few minutes.

Prerequisites

Before you begin, make sure you have:

  • Node.js 18 or higher installed
  • A code editor (VS Code recommended)
  • Basic knowledge of Markdown

Step 1: Install Dependencies

npm install

Step 2: Start Development Server

npm run dev

Your site will be available at http://localhost:4321.

Step 3: Add Your First Page

Create a new markdown file in src/content/docs/getting-started/:

---
title: "My First Page"
description: "My first documentation page"
order: 10
---

# My First Page

This is my first documentation page with JustDocs!

Step 4: Preview Changes

The site will automatically reload with your new page. You’ll see it appear in the sidebar navigation.

Next Steps

Now that you have JustDocs running:

  • Explore the folder structure
  • Customize your theme
  • Add more documentation pages
  • Deploy to production

Troubleshooting

Port Already in Use

If port 4321 is in use:

npm run dev -- --port 3000

Changes Not Showing

Try restarting the dev server:

# Stop with Ctrl+C, then:
npm run dev

On This Page