Skip to content

Latest commit

 

History

History
117 lines (87 loc) · 11.3 KB

README.md

File metadata and controls

117 lines (87 loc) · 11.3 KB

Cecil's logo, created by Cécile Ricordeau

Cecil, a simple and powerful content-driven static site generator.

Latest stable version PHP version require License
Tests status Release status Documentation status
Scrutinizer score Codacy badge Coverage score StyleCI status SymfonyInsight badge

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

Cecil CLI animated demo

Quick Start

Read the Quick Start documentation page.

Create and deploy a blog site:
Deploy to Netlify Deploy with Vercel

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
Arnaud Ligny

🐛 📖 🤔 🚧 📣 💬 👀 🌍 📢
Frank Taillandier
Frank Taillandier

📖 🤔 📣 🌍 🧑‍🏫
Martin Szulecki
Martin Szulecki

🐛 💻 🤔
Matthieu Vion
Matthieu Vion

🐛 💻
Chun-Sheng, Li
Chun-Sheng, Li

💻 🛡️
Benjamin Hirsch
Benjamin Hirsch

🐛 💻
Pete Favelle
Pete Favelle

🐛 💻 🤔
Gert de Pagter
Gert de Pagter

🐛 🚇
Joe Vallender
Joe Vallender

🐛
Jawira Portugal
Jawira Portugal

🐛
Yufan You
Yufan You

🛡️
Mathieu Santostefano
Mathieu Santostefano

📖 🐛

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

npx all-contributors add
npx all-contributors generate

Sponsors

studio cecilliestudio cecillie        Vercel Vercel

License

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

Cecil © Arnaud Ligny
Logo © Cécile Ricordeau