Getting Started with JustDocs

Welcome to JustDocs! This guide will walk you through setting up the most beautiful Astro documentation theme.

Installation

First, create a new Astro project or add JustDocs to your existing project:

npm create astro@latest my-docs -- --template minimal
cd my-docs
npm install justdocs-theme
npm run dev

Configuration

Configure JustDocs in your astro.config.mjs file:

import { defineConfig } from 'astro/config';
import justdocs from 'justdocs-theme';

export default defineConfig({
  integrations: [
    justdocs({
      title: 'My Documentation',
      description: 'Beautiful docs powered by JustDocs',
      social: {
        github: 'https://github.com/yourusername/repo'
      }
    })
  ]
});

Create Your First Page

Create a new markdown file in the src/content/docs/ directory:

---
title: "My First Documentation Page"
description: "This is my first page using JustDocs"
order: 2
category: "Getting Started"
---

# My First Documentation Page

Welcome to your first documentation page! You can write content using Markdown syntax.

## Features

- ✨ Beautiful design
- 🌙 Dark mode support
- 📱 Mobile responsive
- ⚡ Lightning fast

## Code Example

\```javascript
console.log('Hello, JustDocs!');
\```

Development Server

Start the development server to see your documentation site in action:

npm run dev

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

Next Steps

Now that you have JustDocs set up, you can:

• Configure Your Site - Customize colors, fonts, navigation, and more to match your brand.
• Explore Components - Learn about the built-in components and how to create custom ones.