Gh Pages Minima Starter screenshot

Gh Pages Minima Starter

Author Avatar Theme by Jsanz
Updated: 22 Apr 2025
135 Stars

A minimal example for running Github Pages with the minima theme.

Categories

Overview:

The gh-pages-minima-starter is a template and set of instructions designed to help users run Github Pages with the minima theme. This repository provides all the essential components for creating a personal blog using Jekyll and Github Pages, including a front page, an archive for all posts, an about page, a minimum 404 page, and minimum metadata in the _config.yml file. It also includes an example CSS change, a custom footer template, and links to the minima theme documentation and official Github Pages documentation. Users can browse the website or the source code for detailed instructions on creating content and using the Github interface.

Features:

  • Frontpage: Includes the last blog posts.
  • Archive: Provides a page for all posts.
  • About page: Allows users to create an about page.
  • Minimum 404 page: Provides a basic 404 error page.
  • Minimum metadata: Includes the necessary metadata in the _config.yml file.
  • Example CSS change: Allows users to customize the CSS by making changes in the main.scss file.
  • Custom footer template: Provides a customizable footer template.

Installation:

  1. Clone the gh-pages-minima-starter repository to your local machine.
  2. Navigate to the cloned repository directory.
  3. Open the _config.yml file and update the necessary metadata (e.g., site title, description, etc.).
  4. Open the assets/main.scss file and make any desired CSS changes.
  5. Customize the footer by modifying the _includes/footer.html file.
  6. Create your about page by adding content to the _pages/about.md file.
  7. Begin writing blog posts by adding Markdown files to the _posts directory.
  8. Preview the site locally by running the Jekyll server with the command bundle exec jekyll serve.
  9. Deploy the site to Github Pages by following the appropriate instructions in the official docs.

Summary:

Overall, the gh-pages-minima-starter provides a simple and comprehensive template for setting up a personal blog using Jekyll and Github Pages. With features such as a front page, archive, about page, 404 error page, and customizable CSS and footer, this template offers users a solid foundation for creating and customizing their blog. The included instructions and links to documentation further facilitate the process of building and deploying the site.