README

The Butler is a ready to use static blog, powered by Cecil.

There is a demo?

▶️ the-butler-demo.cecil.app (theme: Hyde, host: Netlify)
▶️ the-butler-garth.vercel.app (theme: Garth, host: Vercel)

How to use?

Managing content

Create your own repository from the GitHub template, then just edit Markdown files in pages/blog/.

Customize your blog

1. Change configuration by editing config.yml file
2. Change templates by copying files from themes/<theme>/layouts/ to your own layouts/ directory to override them
   • Hyde: themes/hyde/layouts/
   • Garth: themes/garth/layouts/

Build & deploy

Locally

Run the following command in a terminal:

bash ./scripts/build.sh

Cloud

Provider	Demo	Deploy
Netlify	https://the-butler-demo.cecil.app
Vercel	https://the-butler.vercel.app
GitHub	https://cecilapp.github.io/the-butler/	See GitHub Actions workflow file.
GitLab	https://cecilapp.gitlab.io/the-butler/	See GitLab config file.

Need Help?

Read the Cecil's documentation and/or ask help in Cecil's Discussions.

License

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

© Arnaud Ligny