Introduction

Welcome to WharfDocs, a fully integrated static documentation solution built with PHP.

#What is WharfDocs?

WharfDocs is a standalone PHP application that reads Markdown files based on a structured directory layout to produce beautiful, static documentation websites. It's inspired by modern documentation frameworks like Docus.dev but built entirely with PHP.

#Key Features

This documentation system includes a range of features designed to improve documentation management:

Powered by PHP: No complex build steps or Node.js required
Markdown Support: Write your documentation in simple Markdown format
Auto-generated Navigation: Automatically generates sidebar navigation from your content structure
Full-Text Search: Built-in search functionality for quick content discovery
Syntax Highlighting: Beautiful code blocks with syntax highlighting
Dark Mode: Toggle between light and dark themes
Responsive Design: Works perfectly on desktop, tablet, and mobile devices
Permalink Generation: SEO-friendly URLs for all documentation pages
Table of Contents: Automatic TOC generation for easy navigation

#Why WharfDocs?

Simple Setup: Just PHP and Markdown files - no complex build process
Easy to Deploy: Works on any PHP hosting environment
Fast: Static content generation with efficient caching
Customizable: Easy to theme and extend
Developer Friendly: Clean, well-structured codebase

#Getting Started

Ready to create your documentation? Head over to the Installation guide to get started!