Code Monkey home page Code Monkey logo

kirby-previews's Introduction

This plugin is archived as default previews for Kirby 4 are really good and more refined than the first ones in Kirby 3 which leaded to this plugin. It is no longer necessary.

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)
  • Please read the pluginkit guidelines.

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/index.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.


4. License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.