https://github.com/dps/butler

https://github.com/dps/butler

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dps/butler
• Owner: dps
• License: mit
• Created: 2020-04-12T02:08:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-12T02:09:13.000Z (about 6 years ago)
• Last Synced: 2025-07-21T10:19:43.080Z (11 months ago)
• Language: HTML
• Size: 1.66 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# The Butler

> A ready to use static blog, powered by [Cecil](https://cecil.app).

![Cecil preview](static/images/cecil-preview.png)

## There is a demo?

:arrow_forward: [the-butler.cecil.app](https://the-butler.cecil.app) (theme: [Hyde](https://github.com/Cecilapp/theme-hyde))  

:arrow_forward: [the-butler-garth.now.sh](https://the-butler-garth.now.sh) (theme: [Garth](https://github.com/Cecilapp/theme-garth))

## How to use?

### Managing content

#### With [Forestry](https://forestry.io)

If your goal is managing content quickly, and decide later where to deploy to it, use the following button to import the starter blog to Forestry CMS and start editing immediatelly!

[![Import this project into Forestry](https://assets.forestry.io/import-to-forestryK.svg)](https://cecil.app/cms/forestry/import/)

#### Manually

Edit content files in `content/blog/` directly from your repository.

### Deploy

#### To [Netlify](https://www.netlify.com) ([demo](https://the-butler.cecil.app))

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Cecilapp/the-butler&stack=cms)

To use [**Netlify CMS**](https://www.netlifycms.org) ([demo](https://the-butler.cecil.app/admin/)) you must:

1. enable [Netlify Identity](https://docs.netlify.com/visitor-access/git-gateway/#setup-and-settings) and Git Gateway

2. invite a user

3. connect to `https://.netlify.com/admin/` with the user credentials

#### To [ZEIT Now](https://zeit.co) ([demo](https://the-butler.now.sh))

[![Deploy to ZEIT Now](https://zeit.co/button)](https://zeit.co/new/project?template=https://github.com/Cecilapp/the-butler)

#### To [Render](https://render.com) ([demo](https://the-butler.onrender.com))

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/Cecilapp/the-butler)

#### With [Travis CI](https://travis-ci.com)

See [Travis config file](/.travis.yml).

#### With [GitLab CI](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/) ([demo](https://narno.gitlab.io/the-butler/))

See [GitLab config file](/.gitlab-ci.yml).

#### With [GitHub Actions](https://github.com/features/actions) ([demo](https://cecilapp.github.io/the-butler/))

Edit [GitHub Actions workflow file](/.github/workflows.disabled/build-and-deploy.yml) and rename `workflows.disabled` to `workflows` to enable the workflow.

### Customize your blog

1. Update configuration by editing `config.yml` file

2. Change templates by copying files from `themes//layouts/` to your own `layouts/` directory to _override_ them.

## Need Help?

Read the [Cecil's documentation](https://cecil.app/documentation/).

## License

Starter blog is a free software distributed under the terms of the MIT license.

© [Arnaud Ligny](https://arnaudligny.fr)