- Centralized Docs: All Akawaka project documentation in one place
- Auto-Sync: Docs update automatically via GitHub Actions
- Easy Config: Manage projects with simple YAML files
- Fast Builds: Powered by Cecil for instant previews
📝 Add Projects | 🔄 Doc Sync | 💻 Development |
---|---|---|
⚙️ Config | 🏗️ Structure | ✨ Benefits |
Manage projects via a single YAML file.
- Location:
data/projects.yml
- Purpose: Defines all projects shown on the homepage.
Field | Description |
---|---|
title |
Display name (emojis supported) |
description |
Short summary for the project card |
url |
Link (relative for internal, absolute for external) |
type |
internal or external |
category |
For grouping (e.g., documentation, development) |
featured |
true to show on homepage |
- title: "📚 API Documentation"
description: "Complete API reference for all Akawaka services."
url: "/api/"
type: "internal"
category: "documentation"
featured: true
- Edit
data/projects.yml
- Add a new entry (see above)
- Set
featured: true
to display on homepage - Commit & push
.
├── data/
│ └── projects.yml # Project definitions
├── pages/ # Documentation pages
├── config.yml # Cecil config
├── composer.json # PHP dependencies
└── README.md # This file
- Use GitHub Actions in your project repo to build and push docs here.
- Target the correct subdirectory (e.g.,
/pages/opencode/
). - Trigger a site build after syncing.
Built with Cecil (Symfony-based static site generator).
composer install
bin/cecil build
Outputs to _site/
.
bin/cecil serve
Runs at http://localhost:8000 with hot reload.
- Simple Management: Add/remove projects in YAML
- Consistent Format: All projects follow the same structure
- Flexible Display: Control homepage visibility
- Versioned: All changes tracked in Git
For any Akawaka project, this hub is your go-to for documentation—fast, organized, and always up to date.