Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cecilapp/cecil

Your content driven static site generator.
https://github.com/cecilapp/cecil

cecil-cli-demo cecill flat-file logo markdown php static-site-generator twig

Last synced: about 5 hours ago
JSON representation

Your content driven static site generator.

Host: GitHub
URL: https://github.com/cecilapp/cecil
Owner: Cecilapp
License: mit
Created: 2013-09-10T19:06:45.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2024-05-27T11:21:50.000Z (6 months ago)
Last Synced: 2024-05-29T00:16:55.107Z (6 months ago)
Topics: cecil-cli-demo, cecill, flat-file, logo, markdown, php, static-site-generator, twig
Language: PHP
Homepage: https://cecil.app
Size: 27 MB
Stars: 243
Watchers: 11
Forks: 25
Open Issues: 8
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

        [![Cecil's logo, created by Cécile Ricordeau](https://cecil.app/images/logo-cecil.png)](https://cecil.app)

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

[![Latest stable version](https://poser.pugx.org/cecil/cecil/v/stable)](https://github.com/Cecilapp/Cecil/releases/latest)

[![PHP version require](http://poser.pugx.org/cecil/cecil/require/php)](https://packagist.org/packages/cecil/cecil)

[![License](https://poser.pugx.org/cecil/cecil/license)](https://github.com/Cecilapp/Cecil/blob/master/LICENSE)  

[![Tests status](https://github.com/Cecilapp/Cecil/actions/workflows/test.yml/badge.svg)](https://github.com/Cecilapp/Cecil/actions/workflows/test.yml)

[![Release status](https://github.com/Cecilapp/Cecil/actions/workflows/release.yml/badge.svg)](https://github.com/Cecilapp/Cecil/actions/workflows/release.yml)

[![Documentation status](https://github.com/Cecilapp/Cecil/actions/workflows/docs.yml/badge.svg)](https://github.com/Cecilapp/Cecil/actions/workflows/docs.yml)  

[![Scrutinizer score](https://scrutinizer-ci.com/g/Cecilapp/Cecil/badges/quality-score.png)](https://scrutinizer-ci.com/g/Cecilapp/Cecil/)

[![Codacy badge](https://app.codacy.com/project/badge/Grade/07232d3c7ff34f3da5abdac8f3ad2cee)](https://app.codacy.com/gh/Cecilapp/Cecil/dashboard)

[![Coverage score](https://coveralls.io/repos/github/Cecilapp/Cecil/badge.svg?branch=master)](https://coveralls.io/github/Cecilapp/Cecil?branch=master)

[![StyleCI status](https://github.styleci.io/repos/7548986/shield?style=plastic)](https://styleci.io/repos/12738012)

[![SymfonyInsight badge](https://insight.symfony.com/projects/ada27715-6342-43f8-a1e7-4d5a8fe78e62/mini.svg)](https://insight.symfony.com/projects/ada27715-6342-43f8-a1e7-4d5a8fe78e62)

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://demo.cecil.app) | 🐛 [Issue tracker](https://github.com/Cecilapp/Cecil/issues) | 💬 [Discussion](https://github.com/Cecilapp/Cecil/discussions)

![Cecil CLI animated demo](docs/cecil-cli-demo.gif "Cecil CLI demo")

## Quick Start

Read the [Quick Start](https://cecil.app/documentation/quick-start/) documentation page.

Create and deploy a blog site:  

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg "Deploy to Netlify")](https://cecil.app/hosting/netlify/deploy/) [![Deploy with Vercel](https://vercel.com/button/default.svg "Deploy with Vercel")](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](https://cecil.app/download/) one file 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://cecil.app/cecil.phar

```

Then install the binary globally:

```bash

mv cecil.phar /usr/local/bin/cecil

chmod +x /usr/local/bin/cecil

```

> [!IMPORTANT]

> [PHP](https://www.php.net) 8.1+ is required.

## Usage

- Get help: `cecil help`

- Create a new website: `cecil new:site`

- Preview your website: `cecil 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}
📖 🐛

    

  

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

```

## Sponsors

[![studio cecillie](https://raw.githubusercontent.com/Cecilapp/website/master/static/images/logos/cecillie.png)](https://studio.cecillie.fr#gh-light-mode-only)[![studio cecillie](https://raw.githubusercontent.com/Cecilapp/website/master/static/images/logos/cecillie-dark.png)](https://studio.cecillie.fr#gh-dark-mode-only)        [![Vercel](https://raw.githubusercontent.com/Cecilapp/website/master/static/images/logos/vercel.png)](https://vercel.com/?utm_source=cecil&utm_campaign=oss#gh-light-mode-only)[![ Vercel](https://raw.githubusercontent.com/Cecilapp/website/master/static/images/logos/vercel-dark.png)](https://vercel.com/?utm_source=cecil&utm_campaign=oss#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)