{"id":15056596,"url":"https://github.com/sysgears/grain","last_synced_at":"2025-08-20T01:31:40.921Z","repository":{"id":11130613,"uuid":"13493149","full_name":"sysgears/grain","owner":"sysgears","description":"Grain is a lightweight and powerful static website generator with custom themes to help create static, SEO-friendly websites or a blog in no time.","archived":false,"fork":false,"pushed_at":"2024-03-14T08:02:26.000Z","size":6422,"stargazers_count":160,"open_issues_count":7,"forks_count":30,"subscribers_count":41,"default_branch":"master","last_synced_at":"2024-12-07T18:24:09.329Z","etag":null,"topics":["grain-framework","groovy","static-site-generator"],"latest_commit_sha":null,"homepage":"https://sysgears.com/grain","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sysgears.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2013-10-11T07:59:43.000Z","updated_at":"2024-10-31T15:15:51.000Z","dependencies_parsed_at":"2024-03-14T09:27:46.556Z","dependency_job_id":"42ea7138-62b2-48eb-9850-2436ac7019e7","html_url":"https://github.com/sysgears/grain","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Fgrain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Fgrain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Fgrain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgears%2Fgrain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sysgears","download_url":"https://codeload.github.com/sysgears/grain/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230382858,"owners_count":18216854,"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":["grain-framework","groovy","static-site-generator"],"created_at":"2024-09-24T21:53:54.332Z","updated_at":"2025-08-20T01:31:40.914Z","avatar_url":"https://github.com/sysgears.png","language":"Groovy","funding_links":[],"categories":["Uncategorized","Static Web"],"sub_categories":["Uncategorized"],"readme":"![Banner](https://raw.githubusercontent.com/sysgears/grain/master/banner.png)\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/grainframework.svg?style=social)](https://twitter.com/grainframework) [![Twitter Follow](https://img.shields.io/twitter/follow/sysgears.svg?style=social)](https://twitter.com/sysgears)\n\nGrain is a lightweight framework and a very powerful static website generator written in Groovy to help make website\ncreation intuitive and enjoyable. Grain suits development of complex, static websites for companies and neat blogging\nwebsites for personal use. The framework builds on [simple ideas](#documentation) and provides live reload to help you\nrapidly develop custom [themes](#available-grain-themes).\n\n## Documentation\n\nAll the Grain documentation is located in teh [`docs/General Docs.md`] file. You may learn more about using Grain in the\nfollowing sections:\n\n- [IDE Integration]\n- [Grain website structure]\n- [Environments]\n- [Advanced Grain configuration]\n- [Page structure]\n- [Layouts]\n- [Includes]\n- [URL and resource mapping]\n- [Tag libraries]\n\n## Key features\n\nGrain comes with the following key features:\n\n- A preview mode that allows you to make changes and see them applied on the fly\n- Support for embedded Groovy code for any content files (stylesheets and JavaScript files)\n- Configurable conventions that allow you to process content sources using Groovy\n- Support for Markdown, reStructuredText, and AsciiDoctor\n- Compression and minification of source files\n- Code highlighting with Python Pygments\n- Built-in Sass and SCSS support\n\n## Themes \u0026 templates\n\nA Grain website project is called a _theme_, and Grain has a few developed responsive themes that you can use. Consult the list of pre-built Grain themes below:\n\n- [Agency]\n- [Business Casual]\n- [Clean Blog]\n- [Freelancer]\n- [Grain Stylish Portfolio]\n- [Grain Theme Template]\n- [New Age]\n- [Octopress]\n\n## Getting started\n\n### Requirements\n\nTo run a Grain project, you need to use [JDK 7 or later]. Download and install the appropriate JDK for your operating\nsystem.\n\n### Installation\n\nGrain requires no installation. You only need to download one of the [themes](#available-grain-themes) and run the\nproject \u0026mdash; Grain will be loaded automatically as a JAR dependency.\n\nIf you're new to Grain, we recommend that you start with the [Grain Octopress](#octopress) theme. It gives an overview\nof how you can efficiently use most Grain features.\n\nIf you consider building a Grain website from scratch, try out the [Grain Theme Template](#grain-theme-template).\n\n### Preview a Grain website\n\nNavigate to the location of your newly created website and run the command below to launch the project in preview mode:\n\n```bash\ncd /path/to/your_site\n./grainw\n```\n\n\u003e Here and further the command-line snippets are provided only for the Unix-like operation systems. If you're running\n\u003e Grain on Windows, use the `grainw` command instead of `./grainw`.\n\nOnce the project is built, you can visit your favorite browser at `http://localhost:4000` to view the website. You can\nadd, change, or delete website files and see all the changes in the browser immediately after refreshing the page.\n\n### Generate and deploy\n\nWhen you're ready to deploy your Grain-based website, you first need to generate all the website files by executing the\nfollowing command:\n\n```bash\n./grainw generate\n```\n\nThe website files are generated into the `/path/to/your_site/target` directory.\n\nYou can deploy the website files either manually or with the help of Grain:\n\n```bash\n./grainw deploy\n```\n\nCheck the [Deployment Configuration] section for more information.\n\n## Community Support\n\nThere are many ways to get involved with the project:\n\n- [Issue Tracker] - make Grain better by suggesting improvements\n- [Twitter] - keep up with the latest Grain news and announcements\n\n### Commercial Support\n\nThe [SysGears] team provides comprehensive support for commercial partners. Our team can guide you when you're using\nGrain framework and need professional support.\n\nYou can leave your contacts to us via email [info@sysgears.com](mailto:info@sysgears.com) and we will contact you back within one working day.\n\n## License\n\nGrain is licensed under the [Apache License], Version 2.0.\n\n[Grain]: http://sysgears.com/grain/\n[Apache License]: http://www.apache.org/licenses/LICENSE-2.0.html\n[Issue Tracker]: https://github.com/sysgears/grain/issues\n[Twitter]: http://twitter.com/grainframework\n[deployment configuration]: https://github.com/sysgears/grain/blob/master/docs/latest.md#deployment-configuration\n[`docs/General Docs.md`]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md\n[ide integration]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#ide-integration\n[grain website structure]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#grain-website-structure\n[environments]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#environments\n[advanced grain configuration]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#advanced-grain-configuration\n[page structure]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#page-structure\n[layouts]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#layouts\n[includes]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#includes\n[url and resource mapping]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#url-and-resource-mapping\n[tag libraries]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#tag-libraries\n[agency]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#agency\n[business casual]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#business-casual\n[clean blog]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#clean-blog\n[freelancer]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#freelancer\n[grain stylish portfolio]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#grain-stylish-portfolio\n[grain theme template]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#grain-theme-template\n[new age]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#new-age\n[octopress]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#octopress\n[https://github.com/sysgears/grain-theme-new-age]: https://github.com/sysgears/grain-theme-new-age\n[https://github.com/sysgears/grain-theme-clean-blog]: https://github.com/sysgears/grain-theme-clean-blog\n[https://github.com/sysgears/grain-theme-octopress]: https://github.com/sysgears/grain-theme-octopress\n[octopress]: http://octopress.org/docs/\n[https://github.com/sysgears/grain-theme-template]: https://github.com/sysgears/grain-theme-template\n[https://github.com/sysgears/grain-theme-portfolio]: https://github.com/sysgears/grain-theme-portfolio\n[https://github.com/sysgears/grain-theme-freelancer]: https://github.com/sysgears/grain-theme-freelancer\n[https://github.com/sysgears/grain-theme-agency]: https://github.com/sysgears/grain-theme-agency\n[https://github.com/sysgears/grain-theme-business]: https://github.com/sysgears/grain-theme-business\n[JDK 7 or later]: http://www.oracle.com/technetwork/java/javase/downloads/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgears%2Fgrain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsysgears%2Fgrain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgears%2Fgrain/lists"}