project phpoole-cecil

narno/phpoole-cecil

Your blog's butler.

, _(*1)

A simple and powerful content-driven static site generator., _(*2)

, _(*3)

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

📄Documentation · 💻Demo · 🐛Issues tracker · 💬Discussions, _(*5)

, _(*6)

, _(*7)

Quick Start

Read the Quick Start documentation page., _(*8)

Create and deploy a blog site:
, _(*9)

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:, _(*10)

curl -LO https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar

[!IMPORTANT] PHP 8.1+ is required., _(*11)

Usage

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

Contributing

See Contributing., _(*12)

Thanks goes to these wonderful people (emoji key):, _(*13)

, _(*14)

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 📖 🐛
Max 📖	Progi1984 💻 🤔	Franck Matsos 💻

, _(*15)

This project follows the all-contributors specification. Contributions of any kind welcome!, _(*16)

npx all-contributors add
npx all-contributors generate

Development

Build binary

Build the cecil.phar binary with Box:, _(*17)

# Install Box globally
composer global require humbug/box
# Add Box to your PATH
export PATH=~/.composer/vendor/bin:$PATH
# Build the phar file
composer build
# Check the phar file
php dist/cecil.phar about

Build API documentation

Build the API documentation with phpDocumentor:, _(*18)

# Install phpDocumentor globally
curl -Lo phpdoc https://phpdoc.org/phpDocumentor.phar
# Build the API documentation
php phpdoc

Sponsors

                , _(*19)

License

Cecil is a free software distributed under the terms of the MIT license., _(*20)

Cecil © Arnaud Ligny
Logo © Cécile Ricordeau, _(*21)