https://github.com/sysgears/grain
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.
https://github.com/sysgears/grain
grain-framework groovy static-site-generator
Last synced: 4 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/sysgears/grain
- Owner: sysgears
- License: other
- Created: 2013-10-11T07:59:43.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T08:02:26.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T18:24:09.329Z (about 1 year ago)
- Topics: grain-framework, groovy, static-site-generator
- Language: Groovy
- Homepage: https://sysgears.com/grain
- Size: 6.12 MB
- Stars: 160
- Watchers: 41
- Forks: 30
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-static-generators - Grain - `#Groovy` (Uncategorized / Uncategorized)
- awesome-groovy - Grain - Static Web Site Building Framework For Groovy (Static Web)
README
[](https://twitter.com/grainframework) [](https://twitter.com/sysgears)
Grain is a lightweight framework and a very powerful static website generator written in Groovy to help make website
creation intuitive and enjoyable. Grain suits development of complex, static websites for companies and neat blogging
websites for personal use. The framework builds on [simple ideas](#documentation) and provides live reload to help you
rapidly develop custom [themes](#available-grain-themes).
## Documentation
All the Grain documentation is located in teh [`docs/General Docs.md`] file. You may learn more about using Grain in the
following sections:
- [IDE Integration]
- [Grain website structure]
- [Environments]
- [Advanced Grain configuration]
- [Page structure]
- [Layouts]
- [Includes]
- [URL and resource mapping]
- [Tag libraries]
## Key features
Grain comes with the following key features:
- A preview mode that allows you to make changes and see them applied on the fly
- Support for embedded Groovy code for any content files (stylesheets and JavaScript files)
- Configurable conventions that allow you to process content sources using Groovy
- Support for Markdown, reStructuredText, and AsciiDoctor
- Compression and minification of source files
- Code highlighting with Python Pygments
- Built-in Sass and SCSS support
## Themes & templates
A 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:
- [Agency]
- [Business Casual]
- [Clean Blog]
- [Freelancer]
- [Grain Stylish Portfolio]
- [Grain Theme Template]
- [New Age]
- [Octopress]
## Getting started
### Requirements
To run a Grain project, you need to use [JDK 7 or later]. Download and install the appropriate JDK for your operating
system.
### Installation
Grain requires no installation. You only need to download one of the [themes](#available-grain-themes) and run the
project — Grain will be loaded automatically as a JAR dependency.
If you're new to Grain, we recommend that you start with the [Grain Octopress](#octopress) theme. It gives an overview
of how you can efficiently use most Grain features.
If you consider building a Grain website from scratch, try out the [Grain Theme Template](#grain-theme-template).
### Preview a Grain website
Navigate to the location of your newly created website and run the command below to launch the project in preview mode:
```bash
cd /path/to/your_site
./grainw
```
> Here and further the command-line snippets are provided only for the Unix-like operation systems. If you're running
> Grain on Windows, use the `grainw` command instead of `./grainw`.
Once the project is built, you can visit your favorite browser at `http://localhost:4000` to view the website. You can
add, change, or delete website files and see all the changes in the browser immediately after refreshing the page.
### Generate and deploy
When you're ready to deploy your Grain-based website, you first need to generate all the website files by executing the
following command:
```bash
./grainw generate
```
The website files are generated into the `/path/to/your_site/target` directory.
You can deploy the website files either manually or with the help of Grain:
```bash
./grainw deploy
```
Check the [Deployment Configuration] section for more information.
## Community Support
There are many ways to get involved with the project:
- [Issue Tracker] - make Grain better by suggesting improvements
- [Twitter] - keep up with the latest Grain news and announcements
### Commercial Support
The [SysGears] team provides comprehensive support for commercial partners. Our team can guide you when you're using
Grain framework and need professional support.
You 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.
## License
Grain is licensed under the [Apache License], Version 2.0.
[Grain]: http://sysgears.com/grain/
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0.html
[Issue Tracker]: https://github.com/sysgears/grain/issues
[Twitter]: http://twitter.com/grainframework
[deployment configuration]: https://github.com/sysgears/grain/blob/master/docs/latest.md#deployment-configuration
[`docs/General Docs.md`]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md
[ide integration]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#ide-integration
[grain website structure]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#grain-website-structure
[environments]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#environments
[advanced grain configuration]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#advanced-grain-configuration
[page structure]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#page-structure
[layouts]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#layouts
[includes]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#includes
[url and resource mapping]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#url-and-resource-mapping
[tag libraries]: https://github.com/sysgears/grain/blob/master/docs/General%20Docs.md#tag-libraries
[agency]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#agency
[business casual]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#business-casual
[clean blog]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#clean-blog
[freelancer]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#freelancer
[grain stylish portfolio]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#grain-stylish-portfolio
[grain theme template]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#grain-theme-template
[new age]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#new-age
[octopress]: https://github.com/sysgears/grain/blob/master/docs/Grain%20Themes.md#octopress
[https://github.com/sysgears/grain-theme-new-age]: https://github.com/sysgears/grain-theme-new-age
[https://github.com/sysgears/grain-theme-clean-blog]: https://github.com/sysgears/grain-theme-clean-blog
[https://github.com/sysgears/grain-theme-octopress]: https://github.com/sysgears/grain-theme-octopress
[octopress]: http://octopress.org/docs/
[https://github.com/sysgears/grain-theme-template]: https://github.com/sysgears/grain-theme-template
[https://github.com/sysgears/grain-theme-portfolio]: https://github.com/sysgears/grain-theme-portfolio
[https://github.com/sysgears/grain-theme-freelancer]: https://github.com/sysgears/grain-theme-freelancer
[https://github.com/sysgears/grain-theme-agency]: https://github.com/sysgears/grain-theme-agency
[https://github.com/sysgears/grain-theme-business]: https://github.com/sysgears/grain-theme-business
[JDK 7 or later]: http://www.oracle.com/technetwork/java/javase/downloads/index.html