Magiiic.org

Project Category: Foundation

Library used as a base for projects

  • PHP GitHub Site Generator

    A lightweight PHP static site generator for GitHub projects that creates a professional documentation website with minimal configuration.

    Overview

    This tool automatically generates a static website based on your GitHub repository content. It pulls README.md and other Markdown files from your repo, converts them to HTML, and creates a fully functioning website with navigation, download page, and support functionality.

    Features

    • [x] Home page generated from README.md
    • [x] Additional Markdown pages (e.g., INSTALLATION.md, TROUBLESHOOTING.md)
    • [x] Download page with GitHub Releases information
    • [x] Support page with:
      • List of open GitHub issues
      • Contact form with email notifications
    • [x] Code syntax highlighting with highlight.js
    • [x] Sponsor page with donation links from GitHub FUNDING.yml

    Future Plans

    • Local caching for faster generation
    • Favicon customization
    • Theme customization options

    See in action

    Installation

    1. Clone this repository: 
      git clone https://github.com/magicoli/php-site-generator.git
cd php-site-generator
    1. Install dependencies: 
      composer install
    1. Create configuration file: 
      cp config.json.example config.json
    1. Edit config.json with your project details
    1. Generate the site: 
      php generate.php
    1. Set up a cron task to automatically update your site: 
      
# Edit crontab
crontab -e

    Add a line to run the generator hourly (adjust the path as needed)

    0 cd /home/path/to/php-site-generator && php generate.php >> /var/log/site-generator.log 2>&1

    The cron task will automatically rebuild your site on a regular schedule, keeping the content in sync with your GitHub repository.

    Configuration

    Edit config.json to configure your site:

    {
  "title": "My GitHub Project",
  "github_user": "user",
  "repo": "my-repo",
  "github_branch": "master",
  "github_token": "your_token_here", 
  "support_email": "support@example.com",
  "sender_email": "noreply@example.com",
  "output_folder": "output",
  "menu": [
    { "title": "About", "file": "/" },
    { "title": "Download", "file": "download" },
    { "title": "Installation", "file": "INSTALLATION.md" },
    { "title": "Troubleshooting", "file": "TROUBLESHOOTING.md" },
    { "title": "Support", "file": "support" }
  ]
}

    Important configuration options:

    • github_token: Optional, helps avoid API rate limitations
    • support_email: Required for the support form to function
    • sender_email: Optional, defaults to support_email if not set
    • output_folder: your website root directory (e.g. /var/www/html)

    Project Structure

    
/php-site-generator/
├── config.json            // Configuration for the site and pages
├── generate.php           // Main script to generate the static site
├── template.php           // HTML template for the pages
├── vendor/                // Composer dependencies (Parsedown)
├── assets/                // CSS, images
│   └── style.css          // Custom styling
└── pages/                 // Local Markdown files and templates
    ├── download.md        // Template for download page
    ├── support.md         // Template for support page
    └── partials/          // Reusable page components
        └── support_form.php // Support form template

    ../www/ // Generated static site (output folder defined in config.json) ├── assets │ └── style.css ├── download.html ├── index.html ├── installation.html ├── support.php // PHP for dynamic support form ├── support_form.php // Included in support.php └── troubleshooting.html

    How It Works

    The generate.php script:

    1. Loads your configuration
    2. Fetches content from your GitHub repository
    3. Processes Markdown files into HTML
    4. Creates special pages like download and support
    5. Assembles a complete website with navigation
    6. Outputs everything to your specified folder

    License

    AGPL-3.0

    Credits

  • Karen – Kickass Admin Resource Entitlement Normalizer

    Karen is a lightweight server configuration management system that simplifies the deployment and management of web server configurations.

  • AGNSTK Core Framework

    License: AGPL-v3 PHP Version CMS Agnostic

    This is the AGNSTK Core Framework – the foundational library that powers AGNSTK applications.

    ⚠️ This repository should NOT be used directly!

    Installation

    For new projects: Use the main AGNSTK application template instead:

    git clone https://github.com/magicoli/agnstk.git
cd agnstk
composer install
composer run dev

    For existing projects: This core is automatically included as a git subtree in AGNSTK applications.

    What is this?

    This directory contains the core AGNSTK framework that should NOT be modified directly. It’s managed as a git subtree from the magicoli/agnstk repository.

    For Application Developers

    • DON’T EDIT files in this core/ directory
    • PUT YOUR CODE in the application root directories (src/, config/, etc.)
    • CONFIGURE your application by editing core/config/bundle.php
    • UPDATE THE CORE using git subtree pull --prefix=core https://github.com/magicoli/agnstk.git master --squash

    Bundle Configuration Setup

    After cloning your AGNSTK application, you need to enable bundle configuration tracking:

    1. Remove the ignore rule from your main .gitignore: 
      # Remove this line from .gitignore:
core/config/bundle.php
    1. Track your bundle config: 
      git add core/config/bundle.php
git commit -m "Add bundle configuration"
    1. Customize as needed – edit core/config/bundle.php to match your application structure.

    For AGNSTK Core Contributors

    If you want to contribute to the AGNSTK framework itself:

    1. Work on the core repository: https://github.com/magicoli/agnstk
    2. Changes will be pulled into applications via git subtree updates

    Architecture

    your-agnstk-app/
├── src/                    ← YOUR APPLICATION CODE
├── core/                   ← AGNSTK FRAMEWORK (this directory)
│   ├── config/
│   │   ├── bundle.php     ← YOUR CONFIGURATION
│   │   └── bundle.example.php ← Template
│   ├── app/               ← Framework services
│   └── ...                ← Other framework files
└── ...

    The core provides:

    • Laravel 12 foundation
    • AGNSTK services and helpers
    • Default pages and blocks
    • Multi-platform deployment adapters

    Updates

    Update the core framework:

    git subtree pull --prefix=core https://github.com/magicoli/agnstk.git master --squash

    This uses git subtree to pull the latest changes from agnstk while preserving your application code.

    Need help? Check the main README.md in the application root or visit https://agnstk.org

  • AGNSTK Core Framework

    License: AGPL-v3 PHP Version CMS Agnostic

    This is the AGNSTK Core Framework – the foundational library that powers AGNSTK applications.

    ⚠️ This repository should NOT be used directly!

    Installation

    For new projects: Use the main AGNSTK application template instead:

    git clone https://github.com/magicoli/agnstk.git
cd agnstk
composer install
composer run dev

    For existing projects: This core is automatically included as a git subtree in AGNSTK applications.

    What is this?

    This directory contains the core AGNSTK framework that should NOT be modified directly. It’s managed as a git subtree from the magicoli/agnstk repository.

    For Application Developers

    • DON’T EDIT files in this core/ directory
    • PUT YOUR CODE in the application root directories (src/, config/, etc.)
    • CONFIGURE your application by editing core/config/bundle.php
    • UPDATE THE CORE using git subtree pull --prefix=core https://github.com/magicoli/agnstk.git master --squash

    Bundle Configuration Setup

    After cloning your AGNSTK application, you need to enable bundle configuration tracking:

    1. Remove the ignore rule from your main .gitignore: 
      # Remove this line from .gitignore:
core/config/bundle.php
    1. Track your bundle config: 
      git add core/config/bundle.php
git commit -m "Add bundle configuration"
    1. Customize as needed – edit core/config/bundle.php to match your application structure.

    For AGNSTK Core Contributors

    If you want to contribute to the AGNSTK framework itself:

    1. Work on the core repository: https://github.com/magicoli/agnstk
    2. Changes will be pulled into applications via git subtree updates

    Architecture

    your-agnstk-app/
├── src/                    ← YOUR APPLICATION CODE
├── core/                   ← AGNSTK FRAMEWORK (this directory)
│   ├── config/
│   │   ├── bundle.php     ← YOUR CONFIGURATION
│   │   └── bundle.example.php ← Template
│   ├── app/               ← Framework services
│   └── ...                ← Other framework files
└── ...

    The core provides:

    • Laravel 12 foundation
    • AGNSTK services and helpers
    • Default pages and blocks
    • Multi-platform deployment adapters

    Updates

    Update the core framework:

    git subtree pull --prefix=core https://github.com/magicoli/agnstk.git master --squash

    This uses git subtree to pull the latest changes from agnstk while preserving your application code.

    Need help? Check the main README.md in the application root or visit https://agnstk.org