Git Jekyll Preview

screenshot of Git Jekyll Preview

Preview your Github-hosted websites before making them live.

Overview

Git-Jekyll Preview is a handy tool for web developers who want to preview their GitHub-hosted websites before going live. This application allows users to check both plain static and Jekyll-generated sites, ensuring that everything looks and functions perfectly before deployment to GitHub Pages or their own servers. Designed primarily for a singular location, it provides a seamless experience for developers looking to streamline their workflow.

With the guidance of maintainer Michal Migurski, the Git-Jekyll Preview is continuously improving. Though it's currently not intended for general redeployment, it offers a valuable resource for those working on web projects and seeking a reliable way to test their sites in a controlled environment.

Features

  • Single Location Operation: Primarily designed to run as a singleton app, this tool is optimized for use in a specific setup, enhancing performance and reliability.

  • Static and Jekyll Support: Git-Jekyll Preview allows for the seamless preview of both plain static websites and those built with Jekyll, catering to a wide range of developers and projects.

  • Simple Installation Process: The application can be installed on its own Ubuntu server, with dependencies managed by Chef, making it straightforward for developers familiar with these technologies.

  • Flask-Based Server: Built on a Flask-based Python server, it provides a modern and robust architecture, ensuring efficient handling of requests and operations.

  • Git Integration: By shelling out to Git for interactions with GitHub, this tool keeps workflows efficient and streamlined, making version control more accessible.

  • OAuth Authentication: Utilizes OAuth for secure authentication, requiring developers to enter their client ID and secret, thus ensuring a secure environment for projects.

  • Testing and Production Modes: Offers configurations for both testing and production modes, allowing users to tailor their usage according to their current needs and environment setup.