Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 3.67 KB

README.md

File metadata and controls

69 lines (43 loc) · 3.67 KB
Raw

The Butler

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

The Butler screenshot

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

Manually

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

Netlify CMS

The easiest way to deploy and manage your blog is certainly with Netlify + Netlify CMS.

Deploy to Netlify

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

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 Deploy to Netlify
Vercel https://the-butler.vercel.app Deploy to Vercel
Cloudflare Pages https://the-butler.pages.dev - Framework preset: None
- Build command: curl -sSOL https://cecil.app/build.sh && bash ./build.sh
- Build output directory: _site
GitHub https://cecilapp.github.io/the-butler/ See GitHub Actions workflow file.
GitLab https://cecilapp.gitlab.io/the-butler/ See GitLab config file.
Render https://the-butler.onrender.com Deploy to Render
Travis CI N/A See Travis config file.

To use Netlify CMS (demo) you must:

  1. enable Netlify Identity and Git Gateway
  2. invite a user
  3. connect to https://<your-blog>.netlify.com/admin/ with the user credentials

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