This guide will help you get up and running with Asphinx quickly.
Table of Contents
Installation - How to install Asphinx
Quick Start - Create your first documentation site
Basic Usage - Learn the fundamentals
Project Structure - Understanding the file organization
Prerequisites
Before installing Asphinx, make sure you have:
Rust 1.70+: Required for building Asphinx
Node.js 18+: Required for theme development
AsciiDoctor: Required for document processing
Git: For version control (recommended)
System Requirements
Asphinx runs on:
Linux (Ubuntu 20.04+, Debian 10+, etc.)
macOS (10.15+)
Windows (10+)
Next Steps
Start with Installation to set up Asphinx
Follow the Quick Start guide to create your first site
Explore the User Guide for advanced features