frmurgia / kirby-boilerplate

Kirby Plainkit + Tailwind = 🤍

This Repository extends the Kirby Plainkit by adding the following features:

• Define your CSS with Utility-First using Tailwind CSS
• Includes hot reloading using PostCSS and Gulp
• Kirby is added as a submodule for easy updates
• An opinionated selection of plugins and configurations that I use regularly

Attention: For advanced security, this project uses a public folder setup. This means that the root directory of the web server must point to the ./public folder!

Try Kirby for free

You can try Kirby and the Plainkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you’re convinced, buy your license.

Get going

Getting started is as easy as the following:

# Initially pull Kirby as a submodule
git submodule update --init --recursive

# Install JavaScript dependencies
yarn install

# Start PHP server with Browser hot reloading
yarn dev

# Build CSS files for production
yarn build

For updating Kirby to the latest version, just hit:

./scripts/update_kirby.sh

For getting started with Kirby, read the awesome guide on how to get started with Kirby.

HashandSalts SEO plugin

See: https://github.com/HashandSalt/kirby3-seo

After installing the plugin, setup controllers to bring in the shared SEO controller into each of your template controllers.

The bare minimum controller looks like this:

<?php

return function ($page, $kirby, $site) {

  // SEO
  $seo = $kirby->controller('seo' , compact('page', 'site', 'kirby'));

  return $seo;

};

To override any of the values, you can do this inside your controller. For example, to change the format of the meta title, you could do this:

<?php

return function ($page, $kirby, $site) {

  // Meta
  $seo = $kirby->controller('seo' , compact('page', 'site', 'kirby'));

  // Override Meta Title
  $metatitle = $page->seotitle().' | '.$site->title();

  $data = compact('metatitle');

  return a::merge($seo, $data);

};

You can generate favicons at this website link

What's Kirby?

• getkirby.com – Get to know the CMS.
• Try it – Take a test ride with our online demo. Or download one of our kits to get started.
• Documentation – Read the official guide, reference and cookbook recipes.
• Issues – Report bugs and other problems.
• Feedback – You have an idea for Kirby? Share it.
• Forum – Whenever you get stuck, don't hesitate to reach out for questions and support.
• Discord – Hang out and meet the community.
• Twitter – Spread the word.
• Instagram – Share your creations: #madewithkirby.

---

© 2009-2020 Bastian Allgeier (Bastian Allgeier GmbH)
getkirby.com · License agreement