Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/skn0tt/smillas-test-blog

Last synced: 13 days ago
JSON representation

Host: GitHub
URL: https://github.com/skn0tt/smillas-test-blog
Owner: Skn0tt
License: mit
Created: 2022-09-29T16:52:38.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-09-03T21:40:54.000Z (2 months ago)
Last Synced: 2024-10-06T04:02:59.893Z (about 1 month ago)
Language: HTML
Size: 4.44 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # The Butler

_The Butler_ is a ready to use static blog, powered by [Cecil](https://cecil.app).

[![Cecil preview](assets/images/cecil-preview.png)](https://the-butler.cecil.app "the-butler.cecil.app")

## There is a demo?

:arrow_forward: [the-butler-demo.cecil.app](https://the-butler-demo.cecil.app) (theme: [Hyde](https://github.com/Cecilapp/theme-hyde#readme), host: [Netlify](https://www.netlify.com))  

:arrow_forward: [the-butler-garth.vercel.app](https://the-butler-garth.vercel.app) (theme: [Garth](https://github.com/Cecilapp/theme-garth#readme), host: [Vercel](https://vercel.com))

## How to use?

### Managing content

#### Manually

Create your own repository from the [GitHub template](https://github.com/Cecilapp/the-butler/generate), then just edit Markdown files in `pages/blog/`.

#### Netlify CMS

The easiest way to deploy and manage your blog is certainly with [Netlify](https://www.netlify.com) + [Netlify CMS](https://www.netlifycms.org).

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://cecil.app/hosting/netlify/deploy/ "Deploy to Netlify")

#### Forestry CMS

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](https://forestry.io) and start editing immediatelly!

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

### Customize your blog

1. Change configuration by editing [`config.yml`](https://github.com/Cecilapp/the-butler/blob/master/config.yml) file

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

   - [Hyde](https://github.com/Cecilapp/theme-hyde#readme): [`themes/hyde/layouts/`](https://github.com/Cecilapp/theme-hyde/tree/master/layouts)

   - [Garth](https://github.com/Cecilapp/theme-garth#readme): [`themes/garth/layouts/`](https://github.com/Cecilapp/theme-garth/tree/master/layouts)

### Build & deploy

#### Locally

Run the following command in a terminal:

```bash

bash ./scripts/build.sh

```

#### Cloud

| Solution | Demo | Deploy |

|----------|------|--------|

| [Netlify](https://www.netlify.com) |  | [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://cecil.app/hosting/netlify/deploy/ "Deploy to Netlify") |

| [Vercel](https://vercel.com) |  | [![Deploy to Vercel](https://vercel.com/button)](https://cecil.app/hosting/vercel/deploy/ "Deploy to Vercel") |

| [Render](https://render.com) |  | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://cecil.app/hosting/render/deploy/ "Deploy to Render") |

| [Cloudflare Pages](https://pages.cloudflare.com) |  | - Framework preset: `None`
- Build command: `curl -sSOL https://cecil.app/build.sh && bash ./build.sh`
- Build output directory: `_site` |

| [GitHub](https://github.com/features/actions/) |  | See [GitHub Actions workflow file](/.github/workflows/build-and-deploy.yml). |

| [GitLab CI](https://about.gitlab.com/stages-devops-lifecycle/continuous-integration/) |  | See [GitLab config file.](/.gitlab-ci.yml) |

| [Travis CI](https://travis-ci.com) | N/A | See [Travis config file.](/.travis.yml) |

To use [**Netlify CMS**](https://www.netlifycms.org) ([demo](https://the-butler-demo.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

## Need Help?

Read the [Cecil's documentation](https://cecil.app/documentation/) and/or ask help in Cecil's [Discussions](https://github.com/Cecilapp/Cecil/discussions).

## License

_The Butler_ is a free software distributed under the terms of the MIT license.

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