PHPackages aschmelyun/cleaver-directory - 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 & Views](/categories/templating) 4. / 5. aschmelyun/cleaver-directory ActiveProject[Templating & Views](/categories/templating) aschmelyun/cleaver-directory ============================ A blazing-fast static site generator for local directories built with PHP and Laravel's Blade v1.0.1(6y ago)48188[1 issues](https://github.com/aschmelyun/cleaver-directory/issues)[9 PRs](https://github.com/aschmelyun/cleaver-directory/pulls)MITBladePHP >=7.1.0 Since Mar 30Pushed 3y ago2 watchersCompare [ Source](https://github.com/aschmelyun/cleaver-directory)[ Packagist](https://packagist.org/packages/aschmelyun/cleaver-directory)[ Patreon](https://www.patreon.com/aschmelyun)[ RSS](/packages/aschmelyun-cleaver-directory/feed)WikiDiscussions master Synced today READMEChangelog (2)Dependencies (7)Versions (12)Used By (0) Cleaver Directory ================= [](#cleaver-directory) [![Current Version](https://camo.githubusercontent.com/a45a69c2544696cb65310690b830b08b0890328f01bfeae8fa8032ac96d70ec6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f617363686d656c79756e2f636c65617665722d6469726563746f72792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aschmelyun/cleaver-directory)[![License](https://camo.githubusercontent.com/b02a44cf92ccca91a305ee62559459b697b973e141dc6272d8d24d261bb2023c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f617363686d656c79756e2f636c65617665722d6469726563746f72792e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/b02a44cf92ccca91a305ee62559459b697b973e141dc6272d8d24d261bb2023c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f617363686d656c79756e2f636c65617665722d6469726563746f72792e7376673f7374796c653d666c61742d737175617265)[![Build Status](https://camo.githubusercontent.com/ba15c008000c98b4e5209ec24061959d15a31e980e74cb46068a2a3169fbd01a/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f617363686d656c79756e2f636c65617665722d6469726563746f72792f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/aschmelyun/cleaver-directory)[![Total Downloads](https://camo.githubusercontent.com/e07dee2d3d2ea8d4e5ac1ccacde7d0cb0039129b07f4a860f09f86dc61117b76/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f617363686d656c79756e2f636c65617665722d6469726563746f72792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/aschmelyun/cleaver-directory)[![Netlify Status](https://camo.githubusercontent.com/c278b14f3c15dffe62d5c7cbf5e0c24aed300627b580900a10e2e254d2c24404/68747470733a2f2f6170692e6e65746c6966792e636f6d2f6170692f76312f6261646765732f34353130356465312d666263312d343965312d613762372d3134303639623838316535382f6465706c6f792d737461747573)](https://app.netlify.com/sites/happy-perlman-16e9cc/deploys) 🔥 A blazing-fast static site generator for local directories built with PHP and Laravel's Blade, leveraging JSON or Markdown files for super-extensible content. ``` composer create-project aschmelyun/cleaver-directory your-site-name ``` Why I built this ---------------- [](#why-i-built-this) During the COVID-19 outbreak, I really wanted to utilize my skills and provide my community with something that could be used for a positive purpose. I decided that a directory showcasing local restaurants that are still open, serving take-out and curbside pickup, would be the perfect use of my time. I decided to use my previously-built static site generator Cleaver as the base for this project, modifying and adding functionality, a base layout, and example content. This way, developers of any experience can clone this project for their area, use Markdown to easily add restaurants or businesses, and deploy the whole thing on a service like [Netlify](https://netlify.com) for **absolutely no cost**. Requirements ------------ [](#requirements) - PHP 7.1 or higher - Fairly recent version 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 demo site using the included example content, which outputs to a `dist/` folder in your project root: ``` npm run dev ``` How the directory is structured ------------------------------- [](#how-the-directory-is-structured) Just like with the main Cleaver generator, Cleaver Directory uses a `resources/content` directory to hold Markdown or JSON files that makeup your site. By default, there's a nested folder called `listings`, and this is where you should add in your shops, restaurants, and other businesses in your directory. When rendering a site, the framework will look for content that uses the `layout.listing` view, and passes this array of listings to the index view. Individual listing pages are built from the content files in that `listings` directory. Inside each one, the following variables are required in addition to the view and path on all Cleaver content pages: - title - address - city - state - lat - long See an example content page [here](https://github.com/aschmelyun/cleaver-directory/blob/master/resources/content/listings/taco-dive.md), and further documentation on the main [Cleaver documentation](https://usecleaver.com/docs/) page. You can also have plain content pages (see `submit.md` as an example), that you can use for informational pages, contact areas, FAQ, and more. 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` command from the project root. 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. 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 30 — LowBetter than 65% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity20 Limited adoption so far Community13 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 78.6% 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 ~7 days Total 2 Last Release 2224d ago ### 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 (44 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (12 commits)") --- Tags jsonlaravelgeneratorblademarkdownstaticdirectorysite ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/aschmelyun-cleaver-directory/health.svg) ``` [![Health](https://phpackages.com/badges/aschmelyun-cleaver-directory/health.svg)](https://phpackages.com/packages/aschmelyun-cleaver-directory) ``` ### Alternatives [aschmelyun/cleaver A blazing-fast static site generator using Laravel's Blade templating engine 2961.0k](/packages/aschmelyun-cleaver)[tightenco/jigsaw Simple static sites with Laravel's Blade. 2.2k438.5k29](/packages/tightenco-jigsaw)[tightenco/jigsaw-blog-template Blog starter template for Jigsaw static site generator by Tighten 9464.0k](/packages/tightenco-jigsaw-blog-template)[tightenco/jigsaw-docs-template Documentation starter template for Jigsaw static site generator by Tighten 5026.9k](/packages/tightenco-jigsaw-docs-template)[tomatophp/tomato-admin Tomato Admin Dashboard Build With FilamentPHP Theme for Laravel Splade 578.6k60](/packages/tomatophp-tomato-admin)[rickwest/jigsaw-clean-blog Blog starter template for Jigsaw static site generator by Tighten 111.4k](/packages/rickwest-jigsaw-clean-blog) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)