Flat

Install

composer require pushword/flat-file

Configure (if needed)

Globally under pushword_static_generator (in config/packages).

Or for multi-sites in config/package/pushword.yaml.

...:
  flat_content_dir: content #default value

Usage

Command Line

php bin/console pw:flat:import $host

Where $host is facultative.

Write

By default, the content may be organized in content/%main_host%/ dir and image may be in content/%main_host%/media or in media

Eg:

content
content/homepage.md
content/kitchen-skink.md
content/other-example-kitchen-sink.md
content/en/homepage.md
content/en/kitchen-skink.md
content/media/default/illustation.jpg
content/media/default/illustation.jpg.json

kitchen-skin.md may contain :

---

h1: 'Welcome in Kitchen Sink'
locale: fr
translations:
  - en/kitchen-skink
main_image: illustration.jpg
images:
  - illustration.jpg
parent:
  - homepage
metaRobots: 'no-index'
name: 'Kitchen Sink'
title: 'Kitchen Sink - best google restult'
#created_at: 'now' # see https://www.php.net/manual/fr/datetime.construct.php
#updated_at: 'now'

---

My Page content Yeah !

Good to know :

• camel case or undescore case work
• link to page must use slug
• slug is generate from file path (removing .md) and can be override by a property in yaml front
• homepage 's file could be named index.md or homepage.md
• Other properties will be added to customProperties

illustation.jpg.json may contain

{
  "name": "My Super Kitchen Sink Illustration",
  "createdAt": "now",
  "updatedAt": "now"
}