{"id":13879413,"url":"https://github.com/algolia/frontman","last_synced_at":"2025-06-19T15:41:34.009Z","repository":{"id":49185852,"uuid":"184754295","full_name":"algolia/frontman","owner":"algolia","description":"💎 A Ruby-based static website generator","archived":false,"fork":false,"pushed_at":"2023-03-03T10:46:56.000Z","size":1000,"stargazers_count":110,"open_issues_count":7,"forks_count":4,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-17T21:36:35.675Z","etag":null,"topics":["ruby","ssg","static-site-generator"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/frontman-ssg","language":"Ruby","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/algolia.png","metadata":{"files":{"readme":"readme.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null}},"created_at":"2019-05-03T12:48:15.000Z","updated_at":"2024-12-30T08:23:46.000Z","dependencies_parsed_at":"2022-09-17T22:12:37.749Z","dependency_job_id":null,"html_url":"https://github.com/algolia/frontman","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/algolia/frontman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Ffrontman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Ffrontman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Ffrontman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Ffrontman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/frontman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Ffrontman/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260469428,"owners_count":23014082,"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":["ruby","ssg","static-site-generator"],"created_at":"2024-08-06T08:02:20.276Z","updated_at":"2025-06-19T15:41:28.970Z","avatar_url":"https://github.com/algolia.png","language":"Ruby","readme":"⚠️  **Frontman is currently in an alpha release**, which can involve breaking changes. However, we try to preserve backwards compatibility as much as possible, and we document all changes in the [changelog][changelog].\n\n\u003cdiv align=\"center\"\u003e\n\n# Frontman\n\n[![CircleCI](https://circleci.com/gh/algolia/frontman/tree/master.svg?style=shield\u0026circle-token=ea3dfd1f27a86d050cbc806d3cbd27c1742746ac)](https://circleci.com/gh/algolia/frontman/tree/master)\n[![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)][license]\n[![Gem Version](http://img.shields.io/gem/v/frontman-ssg.svg?style=flat)][gem]\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/algolia/frontman/issues)\n\n\u003cimg src=\"frontman.svg\" alt=\"Frontman\" height=\"200\"/\u003e\n\nFrontman is a static site generator written in Ruby, optimized for speed. It helps you convert your content to static HTML files, so you can focus on your content instead of maintaining servers.\n\n**Check out our [wiki][wiki] for detailed documentation.**\n\n\u003c/div\u003e\n\n## About Frontman\nFrontman is heavily inspired by [Middleman][middleman], a fantastic static site generator with a large community and feature set. We've used it for a long time, with great success.\nHowever, once our project reached a certain size, we realized that Middleman had a few shortcomings when it comes to performance. It was becoming a serious bottleneck for us to iterate fast. After unsuccessfully trying to improve build time, we had to move away from it. Instead of undertaking a huge, lengthy migration to another tool and language, we decided to preserve our current codebase, and create our own, Middleman-inspired static site generator.\n\nThat's how Frontman was born 🚀\n\nWe created Frontman with a strong focus on speed, but also as a quick and easy replacement for Middleman. Our goal was to be able to switch from the Middleman gem to the Frontman gem in your project, and for the migration to take less than a day.\n\nIf you want to dive deeper into why and how we made Frontman faster than other tools, please watch the presentation we gave on [scaling the Algolia documentation][doc_talk].\n\n## Installing Frontman\n\nFirst, make sure you're using Ruby version 2.6 or up. Then, install the Frontman gem on your machine:\n\n```sh\ngem install frontman-ssg\n```\n\n## Creating your site\n\nYou can use the `frontman init` command to initialize a new project in the directory you provide:\n\n```sh\nfrontman init my-project\n```\n\nThen, navigate to the newly created directory:\n\n```sh\ncd my-project\n```\n\n## Developing your site\n\nTo start a development server with a preview of your website, run the following command:\n\n```sh\nfrontman serve\n```\n\n## Building your site\n\nAfter you are happy with your changes, you can generate the HTML for all your pages by using the following command:\n\n```sh\nfrontman build\n```\n\n## Going further\n\nYou can read the [Frontman documentation][wiki] to learn about all the features and possibilities.\n\n## Contributing\n\nWe encourage you to contribute to Frontman if you have ideas for improvements to the project. \nBefore you contribute, please make sure to read our [code of conduct](.github/CODE_OF_CONDUCT.md) and [contributing guidelines](CONTRIBUTING.md).\n\n[changelog]: https://github.com/algolia/frontman/blob/master/CHANGELOG.md\n[doc_talk]: https://www.youtube.com/watch?v=6feV1DrCBdE\n[gem]: https://rubygems.org/gems/frontman-ssg\n[license]: https://github.com/algolia/frontman/blob/master/LICENSE.md\n[middleman]: https://middlemanapp.com/\n[wiki]: https://github.com/algolia/frontman/wiki\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Ffrontman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Ffrontman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Ffrontman/lists"}