Skip to content

KubeAgentic-Community/KubeAgenticWebsite

Repository files navigation

KubeAgentic Website

This repository contains the Jekyll-based website for KubeAgentic - the multi-LLM agent operator for Kubernetes.

🌐 Live Website

📁 Repository Structure

KubeAgenticWebsite/
├── _config.yml              # Jekyll configuration
├── _includes/               # Jekyll includes (custom head, etc.)
├── _layouts/                # Jekyll page layouts
├── assets/                  # Images, logos, favicon, CSS
├── index.md                 # Homepage
├── direct-framework.md      # Direct Framework documentation
├── langgraph-framework.md   # LangGraph Framework documentation
├── examples.md              # Usage examples
├── api-reference.md         # API reference
├── yaml-generator.md        # YAML Generator tool page
├── local-testing.md         # Local testing guide
├── Gemfile                  # Ruby/Jekyll dependencies
├── CNAME                    # Custom domain configuration
└── test-website.sh          # Website testing script

🚀 Quick Start

Prerequisites

  • Ruby 2.5+ and Bundler
  • Jekyll 4.0+

Local Development

  1. Install Dependencies

    bundle install
  2. Run Local Server

    bundle exec jekyll serve
  3. View Website Open http://localhost:4000 in your browser

Testing

./test-website.sh

📝 Content Updates

Adding New Pages

  1. Create a new .md file in the root directory
  2. Add Jekyll front matter:
    ---
    layout: page
    title: "Your Page Title"
    permalink: /your-page-url/
    ---
  3. Add the page to _config.yml in the header_pages section for navigation

Updating Documentation

  • Direct Framework: Edit direct-framework.md
  • LangGraph Framework: Edit langgraph-framework.md
  • API Reference: Edit api-reference.md
  • Examples: Edit examples.md

Assets Management

  • Logos: Located in assets/ directory
  • Images: Place in assets/ directory and reference as /assets/filename.ext
  • Favicon: Update assets/favicon.ico

🔧 Configuration

Jekyll Configuration

Key settings in _config.yml:

  • baseurl: Set to "" for custom domain, /repository-name for GitHub Pages
  • url: Production URL
  • repository: GitHub repository for edit links
  • header_pages: Navigation menu items

Custom Domain

  • Domain configured via CNAME file
  • DNS should point to GitHub Pages servers
  • SSL automatically managed by GitHub Pages

🎨 Customization

Styling

  • Theme: minima (Jekyll default)
  • Custom styles: Add to _includes/head-custom.html
  • Override theme files by creating matching files in repository

Layout

  • Base layout: _layouts/page.html
  • Custom includes: _includes/ directory

📚 Related Repositories

🤝 Contributing

  1. Fork this repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test locally with bundle exec jekyll serve
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

📄 License

This website is part of the KubeAgentic project. See the main repository for license information.

About

Jekyll-based website for KubeAgentic - Multi-LLM Agent Operator for Kubernetes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published