Repository files navigation

Grain is a lightweight framework and a very powerful static website generator written in Groovy to help make websitecreation intuitive and enjoyable. Grain suits development of complex, static websites for companies and neat bloggingwebsites for personal use. The framework builds onsimple ideas and provides live reload to help yourapidly develop customthemes.

All the Grain documentation is located in tehdocs/General Docs.md file. You may learn more about using Grain in thefollowing sections:

• IDE Integration
• Grain website structure
• Environments
• Advanced Grain configuration
• Page structure
• Layouts
• Includes
• URL and resource mapping
• Tag libraries

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

A Grain website project is called atheme, 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

To run a Grain project, you need to useJDK 7 or later. Download and install the appropriate JDK for your operatingsystem.

Grain requires no installation. You only need to download one of thethemes and run theproject — Grain will be loaded automatically as a JAR dependency.

If you're new to Grain, we recommend that you start with theGrain Octopress theme. It gives an overviewof how you can efficiently use most Grain features.

If you consider building a Grain website from scratch, try out theGrain Theme Template.

Navigate to the location of your newly created website and run the command below to launch the project in preview mode:

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 runningGrain on Windows, use thegrainw command instead of./grainw.

Once the project is built, you can visit your favorite browser athttp://localhost:4000 to view the website. You canadd, change, or delete website files and see all the changes in the browser immediately after refreshing the page.

When you're ready to deploy your Grain-based website, you first need to generate all the website files by executing thefollowing command:

./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:

./grainw deploy

Check theDeployment Configuration section for more information.

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

The [SysGears] team provides comprehensive support for commercial partners. Our team can guide you when you're usingGrain framework and need professional support.

You can leave your contacts to us via emailinfo@sysgears.com and we will contact you back within one working day.

Grain is licensed under theApache License, Version 2.0.