{"id":13520145,"url":"https://github.com/aschmelyun/cleaver","last_synced_at":"2025-04-04T20:15:44.436Z","repository":{"id":36468354,"uuid":"226411319","full_name":"aschmelyun/cleaver","owner":"aschmelyun","description":"🔥🔪 A blazing-fast static site generator using Laravel's Blade templating engine","archived":false,"fork":false,"pushed_at":"2023-09-09T17:05:12.000Z","size":2614,"stargazers_count":294,"open_issues_count":33,"forks_count":22,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-10-10T19:25:28.649Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://usecleaver.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aschmelyun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"aschmelyun"}},"created_at":"2019-12-06T21:10:04.000Z","updated_at":"2024-10-08T17:20:24.000Z","dependencies_parsed_at":"2024-06-19T05:31:29.642Z","dependency_job_id":"933bd8fa-2371-4595-afbc-a7ff1ba1511a","html_url":"https://github.com/aschmelyun/cleaver","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aschmelyun%2Fcleaver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aschmelyun%2Fcleaver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aschmelyun%2Fcleaver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aschmelyun%2Fcleaver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aschmelyun","download_url":"https://codeload.github.com/aschmelyun/cleaver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242681,"owners_count":20907134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T05:02:12.621Z","updated_at":"2025-04-04T20:15:44.419Z","avatar_url":"https://github.com/aschmelyun.png","language":"PHP","funding_links":["https://github.com/sponsors/aschmelyun"],"categories":["PHP"],"sub_categories":[],"readme":"# Cleaver\n\n[![Current Version](https://img.shields.io/packagist/v/aschmelyun/cleaver.svg?style=flat-square)](https://packagist.org/packages/aschmelyun/cleaver)\n![License](https://img.shields.io/github/license/aschmelyun/cleaver.svg?style=flat-square)\n[![Total Downloads](https://img.shields.io/packagist/dt/aschmelyun/cleaver.svg?style=flat-square)](https://packagist.org/packages/aschmelyun/cleaver)\n\n:fire: A blazing-fast static site generator that uses Laravel's Blade templating engine and leverages JSON or Markdown files for super-extensible content.\n\n```bash\ncomposer create-project aschmelyun/cleaver your-site-name\n```\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/aschmelyun/cleaver)\n\n## Requirements\n- PHP 7.3 or higher\n- Fairly recent versions of node + npm \n\n## Installation\n\nAfter creating your project with Composer, cd inside your project's root directory and install node dependencies:\n\n```bash\nnpm install\n```\n\nFrom there you can build the site using the included demo content, which outputs to a `dist/` folder in your project root:\n\n```bash\nnpm run dev\n```\n\n## Modifying your assets\n\nCleaver 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.\n\nThere'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.\n\n## Building the site\n\nTo 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.\n\nIf you would like to build your site without compiling the assets, run the `php cleaver build` command from the project root.\n\n## Commands and arguments\n\nIf you build the site by calling `php cleaver build` directly, here's a list of the current commands and accompanying arguments you can use:\n\n- `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`)\n\n## Publishing your site\n\nOnce you're ready to publish your site, simply run the command:\n\n```bash\nnpm run production\n```\n\nWhich will minify your assets and build the site again with the new versioned files.\n\nYou 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.\n\n## Roadmap\nCleaver 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:\n\n- [x] Ability to use folders in content directory\n- [x] Add collection containing all content into each view\n- [x] A better cli interface and style during site builds\n- [x] Ability to add in and use HTML in JSON content files\n- [ ] More detailed build errors if something goes wrong\n- [ ] Create and import site scaffolds from the command line\n\n## Contact Info\n\nHave 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.\n\n## License\n\nThe MIT License (MIT). See [LICENSE.md](https://github.com/aschmelyun/cleaver/blob/master/LICENSE.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faschmelyun%2Fcleaver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faschmelyun%2Fcleaver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faschmelyun%2Fcleaver/lists"}