FlyDocs#

Static documentation sites with PatternFly from markdown.

FlyDocs takes your markdown files and generates a complete documentation site with Red Hat's PatternFly design system. Dark mode, light mode, responsive layout, search, and navigation all work out of the box.

Features#

• PatternFly — Red Hat's open source design system, CSS-only
• Dark / Light / Auto — respects system preference with manual toggle
• Project Felt — default theme, with red accents and pill-shaped controls. flydocs-felt keeps the shapes in blue. flydocs-classic is the previous square theme.
• OKF frontmatter — optional structured metadata for auto-nav and search
• Plain markdown works — no frontmatter required to get a site
• Badges — define once in config, reference anywhere in docs
• Responsive — works on desktop, tablet, and phone
• Lint — validate frontmatter, navigation, and links
• Zero JavaScript frameworks — vanilla JS for toggle and copy

Install#

pip install flydocs

Quick Start#

1. Create a docs/ directory with markdown files:

docs/
  index.md
  quickstart.md
  reference/
    api.md

1. Create flydocs.toml in your project root:

[project]
name = "My Project"

1. Build and preview:

flydocs preview

Your site is at http://localhost:8000.

Add OKF Frontmatter (Optional)#

Add structured metadata to your docs for richer navigation and search:

---
type: Guide
title: Quick Start
description: Get up and running in 5 minutes.
tags: [quickstart, install]
---

OKF v0.2 also adds optional status, stale_after, generated, verified, and sources fields for lifecycle and provenance tracking, aligned with Google's OKF v0.2 spec.

See the OKF Frontmatter reference for the full spec.

Commands#

Configuration#

See the Configuration reference for the full flydocs.toml spec.