Giter VIP home page Giter VIP logo

woodlets's Introduction

Woodlets Build Status

Caution: This plugin is still alpha. There might be breaking changes.
However the only change that is planned until beta release that may break anything is the restructuring of the default templates.
They are used to inherit from in your theme templates. Just keep that in mind and check the changes on the default templates you inherit from before you update until beta is released.
Beta is going to be released very soon.
Feedback and feature requests are welcome!

Woodlets is a WordPress plugin that makes theme development more productive and fun.
The main features are:

  • Heavily Twig based theme development
  • Create widgets with a single Twig-Template file
  • Multi column page layouts
  • Custom page template fields with data inheritance
  • Simple way to add controls to the theme customizer
  • Compatible with native WordPress widgets

Installation

Installation via composer is recommended. But there is also a bundled version that can be installed manually, since using composer is not that common in the WordPress world.

Install via composer

You need to to set installer path for wordpress-plugin type.

{
    "extra": {
        "installer-paths": {
          "vendor/WordPress/wp-content/plugins/{$name}/": [
            "type:wordpress-plugin"
          ]
        }
    }
}

Install Woodlets via composer:

composer require neochic/woodlets

Check "Woodlets Seed"-Theme composer.json for a working example.

Install manually

  1. Go to releases page and download the latest bundled release.
  2. Extract the zip archive to your WordPress plugins directory (usually "wp-content/plugins/").
  3. Activate the plugin on the plugins page of your WordPress installation.

Getting started

  1. Be sure the Woodlets plugin is installed and activated.

  2. Create a new theme (as the WordPress documentation says it should at least contain style.css and index.php)

  3. Put the following lines into your index.php:

    <?php
    do_action('neochic_woodlets_render_template');

    The action neochic_woodlets_render_template initializes the template rendering.

  4. Activate your new theme.

  5. Create your first page template with at least one column. Learn how to create your own page templates.

  6. Create your first Woodlets widget. Learn how to create custom widgets.

  7. Add your new widget to the allowed widgets configuration of your page template column.

  8. Create or edit a page and use your new page layout to test your widget in backend and frontend.

For the creation of new Woodlets themes you may download the "Woodlets Seed"-Theme instead of starting from scratch. It might also be a good idea to take a look at the "Woodlets Example"-Theme.

Further Reading:

woodlets's People

Contributors

cstickel avatar

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.