pushword / flat-file

1.0.51 2026-10-09 23:43 UTC

Requires

• league/csv: ^9.0
• pushword/core: *
• spatie/yaml-front-matter: ^2.0

Suggests

• pushword/admin: Manage pages, media and users from an EasyAdmin-based back-office.
• pushword/admin-block-editor: Rich block editor (EditorJS) for the admin.
• pushword/advanced-main-image: Choose the main image format per page, from hidden to full hero.
• pushword/api: Token-authenticated REST API mirroring the admin, OpenAPI-described.
• pushword/conversation: Add comments, a contact form or any user input to your website.
• pushword/docs: Pushword documentation, readable offline from vendor/.
• pushword/link-improver: Automatic internal links: page names become in-content links at render time.
• pushword/newsletter: Audiences, segmented campaigns and criteria-driven automations.
• pushword/page-scanner: Find dead links, 404s, redirects and TODO reminders.
• pushword/page-update-notifier: Get an email when a page is created or edited.
• pushword/quiz: Interactive client-side quizzes (QCM) and personality tests.
• pushword/repurpose: Turn a page into ready-to-post social carousels (PNG/PDF).
• pushword/search: SQLite-native full-text search via Loupe, zero infrastructure.
• pushword/snippet: Reusable content fragments and dev-registered Twig components.
• pushword/static-generator: Export the whole site as static files (GitHub Pages, Apache, FrankenPHP).
• pushword/template-editor: Edit Twig view files online from the admin.
• pushword/version: Keep a version history of your pages and compare revisions.

MIT

• Robin@PiedWeb

• symfony
• cms
• markdown
• static
• front-matter
• flat-file-cms
• pushword
• git-based-cms

Published on Packagist.org on 2026-10-11 20:41 UTC

README

Turn Pushword into a flat-file CMS — pages and media stored as Markdown + CSV on disk, round-tripped with the database and trackable in Git.

Features

• Two-way pw:flat:sync between Markdown/CSV files and the database.
• Auto-export after admin edits, optional auto git commit.
• Conflict resolution, editorial locks and webhook locking.
• Optional user sync (users.yaml), conversation and snippet sync.

Installation

composer require pushword/flat

Documentation

Visit pushword.piedweb.com/extension/flat.

Sync flow (pw:flat:sync)

Each entity decides its own direction: import when files are newer, export when the database is. Details: sync behavior reference.

flowchart TD
    Start([pw:flat:sync]) --> LockCheck{Webhook lock?}
    LockCheck -->|Yes| Blocked([Blocked])
    LockCheck -->|No| Media{Media: file hash changed?}

    Media -->|Yes| MediaImport[Import media.csv + files<br/>delete media missing from CSV<br/>regenerate media.csv]
    Media -->|No| MediaExport[Export media.csv]
    MediaImport --> Page
    MediaExport --> Page

    Page{Pages: .md newer than DB?} -->|Yes| PageImport[Import redirection.csv + .md<br/>resolve relations, delete orphan pages<br/>regenerate index.csv]
    Page -->|No| PageExport[Export .md, index.csv, redirection.csv]
    PageImport --> Others
    PageExport --> Others

    Others[Conversations, users.yaml, snippets,<br/>extension syncs] --> End([Done])

Loading

The Pushword ecosystem

Pushword is a modular CMS — one Symfony bundle for the core and one bundle per feature. See the full list and guides at pushword.piedweb.com/extensions.

Contributing

If you're interested in contributing to Pushword, please read our contributing docs before submitting a pull request.

Credits

• PiedWeb
• All Contributors

License

The MIT License (MIT). Please see License File for more information.