Getting Started¶

Welcome to the documentation! This guide will help you get up and running quickly.

Installation¶

Install the required dependencies:

pip install -r requirements.txt

Configuration¶

Create a .env file in the project root:

DEBUG=True
SECRET_KEY=your-secret-key-here
SITE_NAME=My Documentation
SITE_DESCRIPTION=Beautiful documentation site

Running the Server¶

Start the development server:

python manage.py migrate
python manage.py runserver

Visit http://localhost:8000 to see your documentation site!

Creating Content¶

Add markdown files to the content/ directory:

• Files are automatically discovered
• Use frontmatter for metadata
• Organize with subdirectories

Example markdown file:

---
title: My Document
order: 1
---

# My Document

Your content here...

Features¶

• Markdown Support: Full markdown syntax with code highlighting
• Automatic Navigation: Sidebar built from file structure
• Search: Built-in search functionality
• Table of Contents: Auto-generated from headings
• Caching: Optional caching for performance