https://github.com/cecilapp/cecil
A simple and powerful content-driven static site generator.
https://github.com/cecilapp/cecil
flat-file markdown php static-site-generator twig
Last synced: 21 days ago
JSON representation
A simple and powerful content-driven static site generator.
- Host: GitHub
- URL: https://github.com/cecilapp/cecil
- Owner: Cecilapp
- License: mit
- Created: 2013-09-10T19:06:45.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T14:52:27.000Z (10 months ago)
- Last Synced: 2025-04-03T00:30:52.570Z (10 months ago)
- Topics: flat-file, markdown, php, static-site-generator, twig
- Language: PHP
- Homepage: https://cecil.app
- Size: 28.2 MB
- Stars: 265
- Watchers: 10
- Forks: 29
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://cecil.app)
A simple and powerful content-driven static site generator.
[](https://github.com/Cecilapp/Cecil/releases/latest)
[](https://github.com/Cecilapp/Cecil/blob/master/LICENSE)
Cecil is a CLI application that merges plain text files (written in [Markdown](http://daringfireball.net/projects/markdown/)), images and [Twig](https://twig.symfony.com) templates to generate a [static website](https://en.wikipedia.org/wiki/Static_web_page).
📄[Documentation](https://cecil.app/documentation) · 💻[Demo](https://the-butler-demo.cecil.app) · 🐛[Issues tracker](https://github.com/Cecilapp/Cecil/issues) · 💬[Discussions](https://github.com/Cecilapp/Cecil/discussions)
[](https://github.com/Cecilapp/Cecil/actions/workflows/continuous-integration.yml)
[](https://github.com/Cecilapp/Cecil/actions/workflows/release.yml)
[](https://github.com/Cecilapp/Cecil/actions/workflows/documentation.yml)
[](https://scrutinizer-ci.com/g/Cecilapp/Cecil/)
[](https://app.codacy.com/gh/Cecilapp/Cecil/dashboard)
[](https://coveralls.io/github/Cecilapp/Cecil?branch=master)
[](https://styleci.io/repos/12738012)
## Quick Start
Read the [Quick Start](https://cecil.app/documentation/quick-start/) documentation page.
Create and deploy a blog site:
[](https://cecil.app/hosting/netlify/deploy/) [](https://cecil.app/hosting/vercel/deploy/)
## Features
- No database, no server, no dependency: performance and security
- Your pages are stored in [Markdown](https://cecil.app/documentation/content/#body) flat files with a [YAML front matter](https://cecil.app/documentation/content/#front-matter)
- Powered by [Twig](https://cecil.app/documentation/templates/), a flexible template engine, with [themes](https://cecil.app/themes) support
- Pagination, sitemap, redirections, robots.txt, taxonomies, RSS are generated automatically
- Handles and optimizes assets for you
- [Download one file](https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar) and run it
- Easy to deploy
## Installation
[Download `cecil.phar`](https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar) from your browser or from your terminal:
```bash
curl -LO https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar
```
> [!IMPORTANT]
> [PHP](https://www.php.net) 8.2+ is required.
## 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](CONTRIBUTING.md).
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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
📖 🐛
Max
📖
Progi1984
💻 🤔
Franck Matsos
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
```bash
npx all-contributors add
npx all-contributors generate
```
## Development
### Build binaries
Build binaries with [Box](https://github.com/box-project/box/) and [phpacker](https://github.com/phpacker/phpacker):
```bash
# Install globally
composer global require humbug/box
composer global require phpacker/phpacker
# Add to your PATH
export PATH=~/.composer/vendor/bin:$PATH
```
```bash
# Build the PHAR file
composer build:phar
# Check the PHAR file
php dist/cecil.phar about
# Build the package (with PHP binary included)
composer build:package
# Check the package
./dist/build//- about
```
### Build API documentation
Build the API documentation with [phpDocumentor](https://www.phpdoc.org):
```bash
# Install phpDocumentor globally
curl -Lo phpdoc https://phpdoc.org/phpDocumentor.phar
# Build the API documentation
php phpdoc
```
## Sponsors
[](https://studio.cecillie.fr#gh-light-mode-only)[](https://studio.cecillie.fr#gh-dark-mode-only) [](https://www.netlify.com#gh-light-mode-only)[](https://www.netlify.com#gh-dark-mode-only)
## License
Cecil is a free software distributed under the terms of the MIT license.
Cecil © [Arnaud Ligny](https://arnaudligny.fr)
Logo © [Cécile Ricordeau](https://www.cecillie.fr)