https://github.com/harrison-broadbent/ruby-middleman-tailwind-starter-blog

A Middleman blog template configured with TailwindCSS, a markdown blog, code highlighting, a sitemap.xml and more. It's perfect for anyone familiar with Ruby.
https://github.com/harrison-broadbent/ruby-middleman-tailwind-starter-blog

blog-template blogging demo-blog middleman middleman-template publishing ruby

Last synced: about 2 months ago
JSON representation

A Middleman blog template configured with TailwindCSS, a markdown blog, code highlighting, a sitemap.xml and more. It's perfect for anyone familiar with Ruby.

• Host: GitHub
• URL: https://github.com/harrison-broadbent/ruby-middleman-tailwind-starter-blog
• Owner: harrison-broadbent
• Created: 2024-05-01T10:48:58.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T06:22:53.000Z (4 months ago)
• Last Synced: 2024-10-14T00:26:04.968Z (2 months ago)
• Topics: blog-template, blogging, demo-blog, middleman, middleman-template, publishing, ruby
• Language: CSS
• Homepage: https://ruby-middleman-tailwind-starter-blog-3sl96oa0w.vercel.app
• Size: 242 KB
• Stars: 51
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ruby Middleman Tailwind Starter Blog

A Middleman blog template configured with TailwindCSS, markdown parsing, code highlighting, a sitemap.xml and more. It perfect for lightweight blogging or a personal website. Ruby knowledge is helpful, but not necessary.

## Features

- Middleman v4.5,

- TailwindCSS v3.4.10,

- Markdown support (via `kramdown`),

- Blogging support (via `middleman-blog`),

- Syntax highlighting support (via `middleman-syntax`),

- Live-reloading (via `middleman-livereload`) and `bin/dev` script,

- Automatic `sitemap.xml` generation,

- SEO-friendly automatic meta tags for `title` and `description`,

- Perfect 100/100 PageSpeed score (near perfect for mobile)

- Github Action for image compression (see `compress_images.yml`).

Visit the [live template demo](ruby-middleman-tailwind-starter-blog-3sl96oa0w.vercel.app) for a preview of how it looks (although of course, you can customize it yourself).

I've used [Middleman](https://middlemanapp.com/) for years to build my personal website, and this template is a consolidation of everything I've learned.

## Getting started

Before you get started, make sure you've got Ruby installed. Currently, this template uses Ruby `v3.3.0`.

Clone this template, then install the required packages and start the server:

```sh

# install Ruby packages & tailwindcss

bundle

npm install

# start dev server

bin/dev

```

## Deploying

This template is easy to deploy. Any static site host should work; I've included the Netlify + Vercel "Deploy" buttons below.

|         |                                                                                                                                                                                                   |

| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| Netlify | [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/harrison-broadbent/ruby-middleman-tailwind-starter-blog) |

| Vercel  | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fharrison-broadbent%2Fruby-middleman-tailwind-starter-blog)              |