cecil.app

Source code of cecil.app website, generated with Cecil (obviously) and hosted by Netlify.

Install

Download Cecil

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

Install dependencies

composer install

Usage

Contribute to the documentation

The documentation is available in docs at github.com/Cecilapp/Cecil.

Create a news entry

php cecil.phar new:page --name=news/cecil-X.Y.0-released --prefix

Preview locally

vendor/bin/tailwind-builder assets/css/tailwind.css -o assets/styles.css --watch
php cecil.phar serve -v --config=config/dev.yml

Build for production

vendor/bin/tailwind-builder assets/css/tailwind.css -o assets/styles.css --minify
php cecil.phar build

Build CSS

composer run css:build

Build translations

French strings live in translations/messages.fr.po (edited with Poedit). The compiled .mo can be regenerated without gettext tools:

composer run i18n:build

Search

The documentation search engine is selected in cecil.yml:

search:
  engine: algolia # 'algolia' (hosted) or 'flexsearch' (client side)

	algolia	flexsearch
Index	/algolia.json, pushed by the netlify-plugin-refresh-algolia Netlify plugin	/search.json, served as a static file
Query	Algolia API (network required)	in the browser, works offline
UI	inline autocomplete (partials/search-algolia.html.twig)	Ctrl/⌘ + K modal (partials/search-flexsearch.html.twig)
Languages	English only (algolia.enabled: false in the French config)	English and French

Both indexes are generated at build time from the documentation sections (<h3> blocks) by list.algolia.twig and list.flexsearch.twig.

When switching to flexsearch, the netlify-plugin-refresh-algolia plugin and the algolia output format can be removed from netlify.toml and cecil.yml.