Unitree Documentation Website

A simple HTML website displaying all Unitree documentation files in a Docker container.

Quick Start

Option 1: Using Docker Compose (Recommended)

docker-compose up --build

Then open your browser to: http://localhost:5000

Option 2: Using Docker directly

docker build -t unitree-docs .
docker run -p 5000:5000 unitree-docs

Then open your browser to: http://localhost:5000

Features

• Simple Navigation: Browse all markdown documentation files from a clean index page
• Markdown to HTML: All .md files are automatically converted to readable HTML
• Responsive Design: Works on desktop, tablet, and mobile
• Code Highlighting: Properly formatted code blocks
• Tables Support: Markdown tables are rendered correctly

Files

• app.py - Flask web application that serves the documentation
• requirements.txt - Python dependencies (Flask, Markdown)
• Dockerfile - Container configuration
• docker-compose.yml - Docker Compose configuration for easy deployment

How it Works

1. The Flask app scans for all .md files in the directory
2. The index page (/) displays links to all available documentation
3. Each documentation file (/doc/<filename>) is rendered as HTML
4. The app runs on port 5000 inside the container

Stopping the Container

Press Ctrl+C in the terminal where Docker is running, or:

docker-compose down