PHPackages                             bristol-digital/qwikblog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. bristol-digital/qwikblog

ActiveLibrary[Parsing &amp; Serialization](/categories/parsing)

bristol-digital/qwikblog
========================

A simple file-based blog system for Laravel with Tailwind CSS

1.0.3(5mo ago)026MITPHPPHP ^8.1|^8.2|^8.3

Since Nov 22Pushed 5mo agoCompare

[ Source](https://github.com/bristol-digital/qwikblog)[ Packagist](https://packagist.org/packages/bristol-digital/qwikblog)[ RSS](/packages/bristol-digital-qwikblog/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (3)Versions (5)Used By (0)

QwikBlog
========

[](#qwikblog)

A simple, file-based blog system for Laravel with Tailwind CSS. No database required.

Features
--------

[](#features)

- 📝 **Markdown-based** - Write posts in simple markdown files
- 🎨 **Tailwind CSS** - Beautiful, responsive design out of the box
- ⚡ **Fast** - File-based with caching
- 🚀 **Zero config** - Drop in and start writing
- 🎯 **Customizable** - Publish views and config to customize

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10.x or 11.x
- Tailwind CSS

Installation
------------

[](#installation)

```
composer require bristol-digital/qwikblog
```

Quick Start
-----------

[](#quick-start)

After installation, try the example data:

```
php artisan blog:install-examples
```

This installs:

- 6 example blog posts
- 6 hero images

Visit `http://yourapp.test/blog` to see your blog in action!

### Remove Example Data

[](#remove-example-data)

Simply delete the files:

```
rm resources/posts/*.md
rm public/images/blog/*.jpg
```

1. **Publish the config:**

```
php artisan vendor:publish --tag=qwikblog-config
```

2. **Create posts directory:**

```
mkdir resources/posts
```

3. **Configure Tailwind** to include package views in `tailwind.config.js`:

```
content: [
    './resources/**/*.blade.php',
    './vendor/bristol-digital/qwikblog/src/resources/**/*.blade.php',
],
plugins: [
    require('@tailwindcss/typography'),
],
```

4. **Install Tailwind Typography:**

```
npm install @tailwindcss/typography
```

5. **Create your first post** `resources/posts/2024-11-20-hello-world.md`:

```
---
title: Hello World
subtitle: My first blog post
category: General
hero_image: /images/hero.jpg
---

This is my first blog post using QwikBlog!

## It supports markdown

- Easy to write
- Easy to read
- Easy to maintain
```

6. **Visit your blog:**

```
http://yourapp.test/blog

```

Usage
-----

[](#usage)

### Creating Posts

[](#creating-posts)

Create markdown files in `resources/posts/` with the naming format:

```
YYYY-MM-DD-slug.md

```

Example: `2024-11-20-my-awesome-post.md`

### Post Format

[](#post-format)

```
---
title: Post Title
subtitle: Post subtitle
summary: Post summary
category: Category Name
hero_image: /path/to/image.jpg
---

Your markdown content here...
```

### Configuration

[](#configuration)

Edit `config/qwikblog.php` to customize:

```
return [
    'posts_path' => resource_path('posts'),
    'layout' => 'layouts.app',  // Your app layout
    'route' => [
        'prefix' => 'blog',  // Change to 'articles', 'news', etc.
        'middleware' => ['web'],
        'name_prefix' => 'blog.',
    ],
    'per_page' => 12,
    'cache_duration' => 3600,
];
```

### Customizing Views

[](#customizing-views)

Publish views to customize the design:

```
php artisan vendor:publish --tag=qwikblog-views
```

Views will be published to `resources/views/vendor/qwikblog/`

### Clearing Cache

[](#clearing-cache)

After adding new posts:

```
php artisan cache:clear
```

or

```
php artisan blog:refresh
```

Routes
------

[](#routes)

The package automatically registers these routes:

- `GET /blog` - Blog index with pagination
- `GET /blog/{slug}` - Individual blog post

License
-------

[](#license)

MIT

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance70

Regular maintenance activity

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

4

Last Release

170d ago

PHP version history (2 changes)1.0.0PHP ^8.1|^8.2|^8.3

1.0.1PHP ^8.0|^8.1|^8.2|^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/00e6bf12722aa1abaf6cfba883f2e7dbb7c93918990f664b4cbd22a06a403dd8?d=identicon)[bristol.digital](/maintainers/bristol.digital)

---

Top Contributors

[![GoProdMe](https://avatars.githubusercontent.com/u/4415910?v=4)](https://github.com/GoProdMe "GoProdMe (21 commits)")

---

Tags

laravelmarkdowntailwindblog

### Embed Badge

![Health badge](/badges/bristol-digital-qwikblog/health.svg)

```
[![Health](https://phpackages.com/badges/bristol-digital-qwikblog/health.svg)](https://phpackages.com/packages/bristol-digital-qwikblog)
```

###  Alternatives

[dniccum/nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.

37116.4k](/packages/dniccum-nova-documentation)[bjuppa/laravel-blog

Add blog functionality to your Laravel project

483.3k2](/packages/bjuppa-laravel-blog)[kindari/laravel-markdown

Markdown Integration with Laravel's View system

411.1k](/packages/kindari-laravel-markdown)[xetaio/xetaravel-editor-md

A wrapper to use Editor.md with Laravel.

232.7k](/packages/xetaio-xetaravel-editor-md)[grazulex/laravel-atlas

Laravel Atlas scans your Laravel project to generate a complete, structured map of its internal components — models, controllers, routes, jobs, observers, events, commands, and more — and exports visual or machine-readable representations in formats like Mermaid, Markdown, JSON, or PDF.

161.7k](/packages/grazulex-laravel-atlas)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
