cecil/cecil

Your content driven static site generator.

8.9.4 2024-04-10 12:39 UTC

Requires

• php: ^8.1||^8.2||^8.3
• ext-fileinfo: *
• ext-gd: *
• ext-mbstring: *
• benjaminhoegh/parsedown-toc: ~1.4.3
• cecil/resource-watcher: ^4.0
• clwu/php-read-mp4info: ^2.0
• cocur/slugify: ^4.5
• dflydev/dot-access-data: ^3.0
• erusev/parsedown-extra: ^0.8
• intervention/image: ^2.7
• laravel-zero/phar-updater: ^1.4
• matthiasmullie/minify: ^1.3
• psr/log: ^3.0
• psr/simple-cache: ^3.0
• scrivo/highlight.php: ^9.18
• scssphp/scssphp: ^1.12
• spatie/image-optimizer: ^1.7
• symfony/config: ^6.4
• symfony/console: ^6.4
• symfony/filesystem: ^6.4
• symfony/finder: ^6.4
• symfony/polyfill-intl-icu: ^1.29
• symfony/process: ^6.4
• symfony/property-access: ^6.4
• symfony/serializer: ^6.4
• symfony/translation: ^6.4
• symfony/twig-bridge: ^6.4
• symfony/validator: ^6.4
• symfony/var-dumper: ^6.4
• symfony/yaml: ^6.4
• twig/intl-extra: ^3.8
• twig/twig: ^3.8
• voku/html-min: ^4.5
• wapmorgan/mp3info: ^0.1
• yosymfony/toml: ^1.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• friendsofphp/php-cs-fixer: ^3.49
• humbug/box: ^4.5
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.8

Suggests

• ext-intl: Intl locales support.

Provides

• psr/log-implementation: 3.0
• psr/simple-cache-implementation: 3.0

MIT

• Arnaud Ligny

• twig
• markdown
• static site generator

README

Cecil, your content driven static site generator.

Cecil is a CLI application that merges plain text files (written in Markdown), images and Twig templates to generate a static website.

📄 Documentation | 💻 Demo | 🐛 Issue tracker | 💬 Discussion

Quick Start

Read the Quick Start documentation page.

Features

• No database, no server, no dependency: performance and security
• Your pages are stored in Markdown flat files with a YAML front matter
• Powered by Twig, a flexible template engine, with themes support
• Pagination, sitemap, redirections, robots.txt, taxonomies, RSS are generated automatically
• Handles and optimizes assets for you
• Download one file and run it
• Easy to deploy

Installation

Download cecil.phar from your browser or from your terminal:

curl -LO https://cecil.app/cecil.phar

Then install the binary globally:

mv cecil.phar /usr/local/bin/cecil
chmod +x /usr/local/bin/cecil

Important

PHP 8.1+ is required.

Usage

• Get help: cecil help
• Create a new website: cecil new:site
• Preview your website: cecil serve

Contributing

See Contributing.

Thanks goes to these wonderful people (emoji key):

Arnaud Ligny 🐛 📖 🤔 🚧 📣 💬 👀 🌍 📢	Frank Taillandier 📖 🤔 📣 🌍 🧑‍🏫	Martin Szulecki 🐛 💻 🤔	Matthieu Vion 🐛 💻
Chun-Sheng, Li 💻 🛡️	Benjamin Hirsch 🐛 💻	Pete Favelle 🐛 💻 🤔	Gert de Pagter 🐛 🚇
Joe Vallender 🐛	Jawira Portugal 🐛	Yufan You 🛡️	Mathieu Santostefano 📖 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

npx all-contributors add
npx all-contributors generate

Sponsors

        

License

Cecil is a free software distributed under the terms of the MIT license.

Cecil © Arnaud Ligny
Logo © Cécile Ricordeau