Jekyll Buildr - Modern Jekyll Development Platform

Jekyll Buildr is a comprehensive development platform for Jekyll websites, available in three integrated versions:

• Web App: Browser-based mini-IDE with AI features
• CLI Tool: Command-line interface for advanced developers
• VS Code Extension: Integrated development environment for VS Code

🌟 Key Features

🖥️ Browser-Based Integrated Development Environment

• Full-Featured Code Editor: In-browser editor with syntax highlighting for HTML, Markdown, YAML, CSS, and more
• File Management: Complete file explorer with create, rename, and delete capabilities
• Real-time Jekyll Preview: Interactive preview pane that shows live updates when running jekyll serve
• Terminal Integration: Built-in terminal emulator with support for Jekyll commands, bundle management, and system operations
• Keyboard Shortcuts: Efficient shortcuts including `Ctrl + `` to toggle terminal

🤖 AI-Powered Development Tools

• AI Component Generation: Describe what you need and generate Jekyll-compliant HTML and Liquid code
• AI Code Completion: Mini-Copilot with real-time code suggestions (Pro feature)
• AI Code Fixes: One-click error correction for problematic code (Pro feature)
• AI Content Generation: Create blog posts and content from text prompts
• AI Image Generation: Generate unique images for your site from descriptions

🔐 Secure GitHub Integration

• GitHub OAuth: Secure authentication using your GitHub account
• Repository Cloning: Import GitHub repositories directly into the editor
• Push to Branch: Commit and push changes directly to your GitHub repository
• Pull Request Creation: Create new branches and pull requests for code review workflows
• Cloud Auto-Save: Automatic saving to Firestore every 2 seconds

💰 Pro Tier Features

• Unlimited Workspaces: Create and manage multiple projects simultaneously
• Advanced AI Tools: Enhanced code completion, fixes, and generation capabilities
• Priority Support: Dedicated support for Pro users

📦 Available Versions

1. Web Application

The browser-based IDE with all features accessible through your web browser.

2. CLI Tool

Command-line interface for developers who prefer terminal-based workflows.

npm install -g jekyll-buildr-cli

3. VS Code Extension

Full integration with Visual Studio Code for desktop development.

ext install DaffaDev.jekyll-buildr

🛠️ Tech Stack

• Framework: Next.js (with App Router)
• Language: TypeScript
• Styling: Tailwind CSS
• UI Components: ShadCN UI
• Authentication & Database: Firebase (Auth, Firestore)
• AI Features: Google AI & Genkit
• Payments: PayPal
• Terminal: xterm.js for terminal emulation

🚀 Getting Started

Web Application

1. Sign In: Log in using your GitHub account at jekyll-buildr.vercel.app
2. Connect GitHub: Install the Jekyll Buildr GitHub App in your repositories
3. Select Project: Choose your repository and branch to begin working
4. Start Developing: Create, edit, and manage your Jekyll site

CLI Tool

# Install globally
npm install -g jekyll-buildr-cli

# Initialize a new project
jekyll-buildr init my-blog

# Or connect to existing project
jekyll-buildr connect <repository-url>

VS Code Extension

1. Install from the VS Code Marketplace
2. Sign in with your Jekyll Buildr account
3. Open your Jekyll project
4. Access all features directly in VS Code

⚙️ Environment Requirements (For Self-Hosting)

To run Jekyll commands within the application, your environment must have:

• Ruby (version 2.5.0 or higher)
• Bundler (installed via gem install bundler)
• Jekyll (installed via gem install jekyll)

Installing Dependencies on Ubuntu/Debian:

# Install Ruby and related tools
sudo apt update
sudo apt install ruby-full build-essential zlib1g-dev

# Install Bundler and Jekyll
gem install bundler jekyll

Installing Dependencies on macOS:

# Using Homebrew
brew install ruby
gem install bundler jekyll

Installing Dependencies on Windows:

• Install Ruby+Devkit from RubyInstaller
• Install Jekyll: gem install jekyll bundler

📚 Using the Integrated Terminal

The web app includes a powerful terminal emulator:

• Open Terminal: Click the >_ icon or press `Ctrl + `` (backtick)
• Run Jekyll Commands: Execute jekyll serve, jekyll build, jekyll doctor
• Manage Dependencies: Run bundle install and other Ruby commands
• System Commands: Use ls, pwd, cat, and other file operations
• Real-time Preview: When running jekyll serve, the preview pane automatically activates

💡 Example Output

Check out a live example of a blog created with Jekyll Buildr: My Blog Site

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

For support, please open an issue in this repository or contact us through the application.