Introducing Peanut for Wordpress

Build your themes and blocks with component-like elements!

Peanut For Wordpress, is an application (and maybe it's a lightweight framework?) built to help with the development process of creating plugins, themes, and blocks. Similar to Wordpress scripts package, it’ll compile all the client side code you need for your blocks and plugins. It will also give you the ability to create reusable “components” within your themes and blocks.

For more of an introduction to this project, you can read our evolving online blog post.

Getting Started

Peanut For Wordpress requires a local development environment running both Node.js and, of course, Wordpress.

NPM Install

To install in your node project, you can run:

npm i @swplabs/peanutforwp --save-dev

Alternatively, you can install globally using the following command:

npm i @swplabs/peanutforwp -g

Note: Installing globally will allow you to run the "peanut" cli command anywhere. This is helpful when you have multiple projects with different source directories.

Clone the GitHub repo

You can download the full source from our public GitHub repo using this link or go to our GitHub repo homepage for cloning instructions similiar to this:

git clone [email protected]:swplabs/peanut.git

For more on setup and how to get started with using Peanut in your local Wordpess development process, visited our Quickstart page on Gitbooks.

More Documentation

Online documentation can be found at Peanut for Wordpress on Gitbooks.

Support Us