Getting Started

Installation

installing WordSmith is simple, all you need is a running WordPress installation and you’re good to go.

There are two ways to install WordSmith; The plugin, Composer

The Plugin

Installing the plugin is the safest way to add the library to your site without messing with your theme and plugins.

Download the Plugin

Via Composer

Installing via Composer is simple, just type to following command in and you’re good to go.

composer require nk2580/wordsmith

Usage

To use the framework in a plugin or theme there are two generators available which will get you started.

Both of the generators use Node & Yeoman so you'll need to install those first.

Theme Generator

The theme generator gives you a blank canvass to build your app. click on the button below to learn more.

Theme Generator Docs

Plugin Generator

The plugin generator allows you to inject pretty much anything into your wordpress site, configuring the a plugin is a little more difficult then the theme but the possibilities are endless.

Plugin Generator Docs