Minizuku is a WordPress theme framework for child themes development.
PHP CSS JavaScript Shell
Clone or download
Latest commit 9f93837 Jun 26, 2018
Permalink
Failed to load latest commit information.
.travis Some fixes Mar 24, 2018
bin Some fixes Mar 26, 2018
resources 6.1.0 Jun 26, 2018
tests Refactoring directory structure Aug 1, 2017
.editorconfig Some fixes Dec 13, 2016
.gitignore 5.0.1 Mar 27, 2018
.travis.yml Some fixes Mar 24, 2018
README.md Some updates Nov 23, 2017
codesniffer.ruleset.xml Some fixes Sep 21, 2017
composer.json 6.1.0 Jun 26, 2018
composer.lock 6.1.0 Jun 26, 2018
gulpfile.js 6.0.0 Jun 15, 2018
license.txt Some fixes Oct 11, 2016
mimizuku.svg Refactoring with inc2734/mimizuku-core Aug 14, 2017
package.json 6.0.0 Jun 15, 2018
phpmd.ruleset.xml Refactoring directory structure Aug 1, 2017
phpunit.xml Refactoring directory structure Aug 1, 2017
yarn.lock 6.0.0 Jun 15, 2018

README.md

Mimizuku

Build Status Latest Stable Version License

Mimizuku is a WordPress starter theme or theme framework for child themes development.

Mimizuku

Requirements

  • WordPress 4.7
  • PHP 5.6+
  • WP-CLI
  • Composer
  • Node.js
  • Yarn

Browser support

  • IE10 + Modern browser

Get Started

Using as starter theme

$ cd /PATH/TO/wp-content/themes
$ git clone https://github.com/inc2734/mimizuku.git your-theme-name
$ cd your-theme-name
$ yarn install
$ composer install
$ yarn run gulp build
$ wp theme activate your-theme-name
  • Replace /resources/languages/mimizuku.pot to /resources/languages/your-theme-name.pot
  • Replace Text Domain: mimizuku to Text Domain: your-theme-name in /style.css
  • Replace apply_filters( 'mimizuku to apply_filters( 'your_theme_name in **.php
  • Replace do_action( 'mimizuku to do_action( 'your_theme_name in **.php
  • Replace add_filter( 'mimizuku to add_filter( 'your_theme_name in **.php
  • Replace add_action( 'mimizuku to add_action( 'your_theme_name in **.php
  • Replace mimizuku to your-theme-name in **.php and **.js
  • Replace Mimizuku to Your_Theme_Name in **.php and **.js

Using as parent theme

See https://github.com/inc2734/mimizuku-child

Theme features

  • Having layout and view templates
  • and having filter hooks filtered these templates
  • Using view controller
  • The function which to pass the variables to WordPress's get_template_part().
  • Usuful scripts
  • CI
  • See more https://github.com/inc2734/mimizuku-child

Directory structure

themes/mimizuku
├─ resources               # The theme root
│  ├─ app                  # Setup theme
│  ├─ page-template        # Custom page templates
│  ├─ templates
│  │  ├─ layout            # Layout templates
│  │  ├─ view              # View templates
│  │  ├─ static            # Static view templates
│  │  └─ widget            # Templates for WP Awesome Widgets
│  ├─ vendor               # Composer packages
│  ├─ style.css            # Theme meta information
│  ├─ index.php
│  ├─ functions.php
│  ├─ ...
├─ .gitignore

Template hierarchical

Layout templates

  1. /resources/vendor/inc2734/mimizuku-core/src/view/templates/**/*.php
  2. /resources/templates/**/*.php

Custo page templates

  1. /resources/page-templates/*.php
  2. /page-templats/*.php

Base templates

  1. /resources/vendor/inc2734/mimizuku-core/src/view/*.php
  2. /resources/*.php
  3. /*.php

Third-party resources

Font Awesome (Web fonts)

Basis (Sass/CSS framework)

FLOCSS

inc2734/wp-breadcrumbs

inc2734/wp-ogp

inc2734/wp-oembed-blog-card

inc2734/wp-view-controller

inc2734/wp-basis

inc2734/wp-customizer-framework

inc2734/wp-github-theme-updater

inc2734/wp-share-buttons

inc2734/wp-seo

inc2734/wp-like-me-box

inc2734/wp-pure-css-gallery

inc2734/wp-awesome-widgets

inc2734/wp-awesome-compponents

Official goods store

https://suzuri.jp/inc2734/products