Petal Docs will be a Free & Open Source (Apache 2.0) documentation generator and theming toolkit with a calm, sakura‑inspired aesthetic.
Goal: turn Markdown collections into a fast, accessible static site with minimal configuration and tasteful visual identity.

Create a lightweight Static Site Generator (SSG) focused on:

• Writer ergonomics (just Markdown + optional frontmatter)
• Readability first (typography, spacing, color contrast)
• Subtle theming personality (sakura accents without visual noise)
• Extensibility via simple component / shortcode primitives (later)

1. Clarity over spectacle (content must remain the hero)
2. Zero required JavaScript for baseline navigation & reading
3. Progressive enhancement (search, dark mode, interactive blocks)
4. Predictable build pipeline (deterministic output)
5. Pluggable but not tangled (themes & processors isolated)

• CLI: petal build src/ -o dist/
• Frontmatter support (title, description, nav_order, tags)
• Automatic sidebar & breadcrumb generation
• Search index (client-side, likely Fuse-based; optional)
• Dark / light / auto theme
• Built-in components: callouts, badges, code block enhancements
• Mermaid diagram rendering (optional)
• Asset hashing + clean relative linking
• Theme override directory (theme/)

• Complex server-side dynamic rendering
• Full CMS / database integration
• Heavy client frameworks or SPA routing

docs/
  getting-started.md
  concepts/
    architecture.md
    glossary.md
  guides/
    extending-theme.md

Frontmatter example (planned):

---
title: Getting Started
description: How to begin using Petal Docs.
nav_order: 1
tags: [intro]
---
# Getting Started
...

1. Minimal parser + file walker
2. Static HTML emitter + base theme
3. Navigation + frontmatter metadata
4. Dark/light mode + small search
5. Components / shortcodes
6. Plugin API + theme packaging

Concept stage only. No functional code has been published yet. This repository currently represents future intent.

Planned & intended license: Apache License 2.0 (will be present before first code commit).

MkDocs, Docusaurus, Hugo, Zola, and minimalist typographic design systems.

“Documentation can carry identity without sacrificing clarity.”