Skip to content
Add some missing structure previews. Kirby 3 only.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.editorconfig
.gitignore
README.md
composer.json
gulpfile.js
index.css
index.js
index.php
package.json

README.md

Kirby Previews

Add some missing structure previews in the panel.

screenshot

This plugin is completely free and published under the MIT license. However, if you are using it in a commercial project and want to help me keep up with maintenance, please consider making a donation of your choice or purchasing your license(s) through my affiliate link.


1. Installation

Download and copy this repository to /site/plugins/previews

Alternatively, you can install it with composer: composer require sylvainjule/previews


2. Setup

That's it, no need for additional config. This plugin currently provides those field-previews :


3. Add / edit a preview

  • Clone the repo
  • cd to your newly created folder (named kirby-previews, or whatever you have chosen)
  • npm install to get all the dependencies (first, install npm if needed)
  • There are two useful command lines:
# Dev mode
npm run dev

# Build plugin + autoprefix styles
npm run build

From there, adding a new preview might only take a few minutes:

  • Start by running the plugin in dev mode to benefit from hot-reload while working on your preview (npm run dev)
  • Create a new preview under src/components (check the existing previews for how to structure content).
  • Add your preview CSS in src/assets/styles.scss
  • Register you new preview in src/main.js (check the existing previews for how to do this).
  • Build the plugin (npm run build)
  • Create a pull request

You must run the build process before pushing the repo, else the hot-reload code will prevent it to work in any install.


4. License

MIT

You can’t perform that action at this time.