PHPackages                             aschmelyun/cleaver - 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. [Templating &amp; Views](/categories/templating)
4. /
5. aschmelyun/cleaver

ActiveProject[Templating &amp; Views](/categories/templating)

aschmelyun/cleaver
==================

A blazing-fast static site generator using Laravel's Blade templating engine

v1.6.4(4y ago)2961.0k21[18 issues](https://github.com/aschmelyun/cleaver/issues)[15 PRs](https://github.com/aschmelyun/cleaver/pulls)MITPHPPHP &gt;=7.2.5

Since Dec 6Pushed 2y ago4 watchersCompare

[ Source](https://github.com/aschmelyun/cleaver)[ Packagist](https://packagist.org/packages/aschmelyun/cleaver)[ GitHub Sponsors](https://github.com/aschmelyun)[ RSS](/packages/aschmelyun-cleaver/feed)WikiDiscussions main Synced 4w ago

READMEChangelog (10)Dependencies (9)Versions (34)Used By (0)

Cleaver
=======

[](#cleaver)

[![Current Version](https://camo.githubusercontent.com/0ed6e2d78191fd151d6dae7f6ef46de9f4204a6d3d3c942a7495e18eff2e135b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f617363686d656c79756e2f636c65617665722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aschmelyun/cleaver)[![License](https://camo.githubusercontent.com/0f88953603300af31c141a20fd788567116152bd052b341bedc138e2b795d45f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f617363686d656c79756e2f636c65617665722e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/0f88953603300af31c141a20fd788567116152bd052b341bedc138e2b795d45f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f617363686d656c79756e2f636c65617665722e7376673f7374796c653d666c61742d737175617265)[![Total Downloads](https://camo.githubusercontent.com/8620dd0354239dd00118110f92f8c108e2a4fb23f0527e46cd49ffa6c78281e4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f617363686d656c79756e2f636c65617665722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aschmelyun/cleaver)

🔥 A blazing-fast static site generator that uses Laravel's Blade templating engine and leverages JSON or Markdown files for super-extensible content.

```
composer create-project aschmelyun/cleaver your-site-name
```

[![Deploy to Netlify](https://camo.githubusercontent.com/de47084e2d5a8948486a2238f1517e465560ec293c4a2cba80020472f8d5c80a/68747470733a2f2f7777772e6e65746c6966792e636f6d2f696d672f6465706c6f792f627574746f6e2e737667)](https://app.netlify.com/start/deploy?repository=https://github.com/aschmelyun/cleaver)

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

[](#requirements)

- PHP 7.3 or higher
- Fairly recent versions of node + npm

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

[](#installation)

After creating your project with Composer, cd inside your project's root directory and install node dependencies:

```
npm install
```

From there you can build the site using the included demo content, which outputs to a `dist/` folder in your project root:

```
npm run dev
```

Modifying your assets
---------------------

[](#modifying-your-assets)

Cleaver uses SCSS for styling, and there's a basic skeleton structure set up in the `resources/assets/sass` directory. Tailwind is imported by default so you can jump right in to rapid development and prototyping.

There's a bootstrapped JavaScript file that imports lodash, jQuery, and Vue dependencies through npm to use with your project. That can be modified by editing the `resources/assets/js/app.js` file.

Building the site
-----------------

[](#building-the-site)

To compile the SCSS/JS assets and build the static site files, you can run `npm run dev` from the root. Additionally, using `npm run watch` starts up a local node server that you can use to view your compiled project, and will watch the entire `resources/` directory for changes to any assets, views, or content files.

If you would like to build your site without compiling the assets, run the `php cleaver build` command from the project root.

Commands and arguments
----------------------

[](#commands-and-arguments)

If you build the site by calling `php cleaver build` directly, here's a list of the current commands and accompanying arguments you can use:

- `php cleaver build {page}` builds the current site, rendering your content in the `resources/content` directory and outputting HTML organized in a directory tree to `/dist`. You can choose to render a single page or just a specific path in your content by including a `page` argument. (e.g. `php cleaver build posts/my-cool-post.md`)

Publishing your site
--------------------

[](#publishing-your-site)

Once you're ready to publish your site, simply run the command:

```
npm run production
```

Which will minify your assets and build the site again with the new versioned files.

You can then publish your entire project to a host of your choice as long as the web root is pointed to the `/dist` folder. Additionally, you're free to just publish the built files in the dist folder by themselves.

Roadmap
-------

[](#roadmap)

Cleaver is still very much in development, and while it's designed to remain as simple as possible there's a few features that could make for a better overall experience. Here's what's on the path ahead:

- Ability to use folders in content directory
- Add collection containing all content into each view
- A better cli interface and style during site builds
- Ability to add in and use HTML in JSON content files
- More detailed build errors if something goes wrong
- Create and import site scaffolds from the command line

Contact Info
------------

[](#contact-info)

Have an issue? Submit it here! Want to get in touch or recommend a feature? Feel free to reach out to me on [Twitter](https://twitter.com/aschmelyun) for any other questions or comments.

License
-------

[](#license)

The MIT License (MIT). See [LICENSE.md](https://github.com/aschmelyun/cleaver/blob/master/LICENSE.md) for more details.

###  Health Score

36

—

LowBetter than 81% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 84.9% 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 ~43 days

Recently: every ~35 days

Total

19

Last Release

1564d ago

PHP version history (2 changes)v1.0.0PHP &gt;=7.1.0

v1.5.0PHP &gt;=7.2.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/89d40a36efd670c752d8d6e488192d9ae78b9ff49503cf6b671f46d17cb67768?d=identicon)[aschmelyun](/maintainers/aschmelyun)

---

Top Contributors

[![aschmelyun](https://avatars.githubusercontent.com/u/3395980?v=4)](https://github.com/aschmelyun "aschmelyun (79 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (13 commits)")[![morpheus7CS](https://avatars.githubusercontent.com/u/8884582?v=4)](https://github.com/morpheus7CS "morpheus7CS (1 commits)")

---

Tags

jsonlaravelgeneratorblademarkdownstaticsite

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/aschmelyun-cleaver/health.svg)

```
[![Health](https://phpackages.com/badges/aschmelyun-cleaver/health.svg)](https://phpackages.com/packages/aschmelyun-cleaver)
```

###  Alternatives

[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.2k438.5k29](/packages/tightenco-jigsaw)[sculpin/sculpin

Static Site Generator

1.5k102.8k12](/packages/sculpin-sculpin)

PHPackages © 2026

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