Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kermage/generator-themeplate

A Yeoman generator to kickstart WordPress development
https://github.com/kermage/generator-themeplate

theme-development wordpress yeoman-generator

Last synced: about 2 months ago
JSON representation

A Yeoman generator to kickstart WordPress development

Host: GitHub
URL: https://github.com/kermage/generator-themeplate
Owner: kermage
License: mit
Created: 2015-11-15T19:17:54.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-03-25T12:12:52.000Z (10 months ago)
Last Synced: 2024-11-29T12:22:18.461Z (about 2 months ago)
Topics: theme-development, wordpress, yeoman-generator
Language: PHP
Homepage: https://www.npmjs.com/package/generator-themeplate
Size: 850 KB
Stars: 12
Watchers: 4
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# generator-themeplate -- ![NPM Version](https://img.shields.io/npm/v/generator-themeplate.svg) ![NPM Downloads](https://img.shields.io/npm/dt/generator-themeplate.svg)

> *"Quickly scafold a complete WordPress site project in seconds!"*

## Features

- Fully-fleshed out package
- Follows WordPress standards
- Streamlined with Gulp
- Sass
- Autoprefixer
- Typescript
- Babel
- Rollup
- Sourcemaps
- Minification
- Browsersync
- Linters
- Localization
- Powered by [ThemePlate](https://github.com/kermage/ThemePlate)
- Font Awesome [v5](https://fontawesome.com/) *(optional)*
- CSS Framework options
- Tailwind CSS [v3](https://tailwindcss.com/)
- Twitter Bootstrap [v5](https://getbootstrap.com/)
- Blank Slate *(with [normalize.css](https://necolas.github.io/normalize.css/))*
- Pre-included boilerplates and functions
- Base theme template files
- Compatibility checks
- Theme Features
- Navigations
- Widgets
- Scripts and Styles
- Actions and Filters
- Plugins *(required/recommended)*
- Custom forms/fields *(metaboxes)*
- Custom post types and taxonomies
- Clean navbar walker
- Google tracking codes
- Asynchronous loading and deferred execution of scripts

## Requirements

- [Node.js](https://nodejs.org/): Install from the NodeJS website.
- [Gulp](https://gulpjs.com/): Run `npm install -g gulp-cli`
- [Yeoman](https://yeoman.io/): Run `npm install -g yo`

## Installation

`npm install -g generator-themeplate`

## Usage

### Setup

#### 1. In the desired project directory, initiate the generator

`yo themeplate`

#### 2. Simply follow the prompts and enter the details

```text
? Project Name:
? Project URI:
? Author:
? Author Email:
? Author URI:
? Description:
? Function Prefix:
? Class Prefix:
? Constant Prefix:
? Use Font Awesome? (Y/n)
? CSS Framework:
? License:
? License URI:
? Local Server:
```

### Development

#### 1. Navigate to the generated directory

#### 2. Run `gulp`

- Builds assets
- Sass and Javascript/Typescript compiled
- Images copied with WebP format
- Watches files and assets for changes
- Starts Browsersync

#### Available Tasks

- `npm run lint` and `npm run fix` - Run scripts and styles against the coding rules set
- `gulp pot` - Generate a POT file for the localization
- `gulp bump` - Bump version in files; package and assets

##### Bump Options

- `--to-type={major|minor}`
- `--to-version={#}`

### Production

#### 1. Run `gulp build --production`

- Assets minified (images optimized; loseless)

#### 2. Set the theme debug constant to `false`

- Specifies to serve the minified assets
- Line is in the theme's `functions.php` file

#### 3. Move out the plugin folder inside the theme

- Standard and default path at `wp-content/plugins`
- Plugin folder is named the same with the theme folder

## License

Licensed under [MIT](LICENSE).