Wallogit.com
2017 © Pedro Peláez
Static site generator
Genny is a static site generator built primarily with Symfony components., (*1)
Simply run "composer install" in the root of your project., (*2)
Twig templates are used to generate site content. These are stored in the templates directory in the root of your project., (*3)
Pages are YML files describing the URL, template and content for a page., (*4)
The following example would result in dist/index.html being created, using the template homepage.html.twig., (*5)
# pages/homepage.yml
page:
_title: My Page Title # Optional
_description: My Page Description # Optional
_url: /index.html # Required
_template: homepage.html.twig # Required
my_example_list:
- Example Item 1
- Example Item 2
The associated template for the example above would look something like this, (*6)
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title>{{ _title }}</title>
<meta name="description" content="{{ _description }}">
</head>
<body>
<h1>Homepage</h1>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
<ul>
{% for item in my_example_list %}
<li>{{ item }}</li>
{% endfor %}
</ul>
</body>
</html>
Genny provides a command line interface for generating pages., (*7)
Generate all pages, (*8)
app/genny generate-page
Generate a specific page, (*9)
app/genny generate-page homepage
Preview a page, (*10)
app/genny generate-page --preview homepage
Watch all templates and pages for changes, generating new files in dist as they happen., (*11)
app/genny watch
Genny can also be used in an existing Symfony project, (*12)
$bundles = array(
// ...
new Kyoushu\Genny\Bundle\GennyBundle(),
// ...
);
genny:
dist_dir: "%kernel.root_dir%/../web"
templates_dir: "%kernel.root_dir%/../src/Acme/DemoBundle/Resources/views"
pages_dir: "%kernel.root_dir%/../src/Acme/DemoBundle/Resources/pages"
Commands can be executed using Symfony's console, (*13)
app/console genny:generate-page
Static site generator