inc2734

mimizuku

# Mimizuku [](https://travis-ci.org/inc2734/mimizuku) [](https://packagist.org/packages/inc2734/mimizuku) [](https://packagist.org/packages/inc2734/mimizuku) Mimizuku is a WordPress starter theme or theme framework for child themes development. <img src="https://cdn.rawgit.com/inc2734/mimizuku/develop/mimizuku.svg" alt="Mimizuku" width="96px"> * GitHub: https://github.com/inc2734/mimizuku/ * Packagist: https://packagist.org/packages/inc2734/mimizuku ## Requirements * WordPress 4.7 * PHP 5.6+ * WP-CLI * Composer * Node.js ## 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 $ npm install $ composer install $ npm run 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) * Font License: SIL OFL 1.1 * Code License: MIT License * Source: https://fortawesome.github.io/Font-Awesome/ ### Basis (Sass/CSS framework) * License: MIT License * Source: https://sass-basis.github.io/ ### FLOCSS * Source: https://github.com/hiloki/flocss ### inc2734/wp-breadcrumbs * Source: https://github.com/inc2734/wp-breadcrumbs ### inc2734/wp-ogp * Source: https://github.com/inc2734/wp-ogp ### inc2734/wp-oembed-blog-card * Source: https://github.com/inc2734/wp-oembed-blog-card ### inc2734/wp-view-controller * Source: https://github.com/inc2734/wp-view-controller ### inc2734/wp-basis * Source: https://github.com/inc2734/wp-basis ### inc2734/wp-customizer-framework * Source: https://github.com/inc2734/wp-customizer-framework ### inc2734/wp-github-theme-updater * Source: https://github.com/inc2734/wp-github-theme-updater ### inc2734/wp-share-buttons * Source: https://github.com/inc2734/wp-share-buttons ### inc2734/wp-seo * Source: https://github.com/inc2734/wp-seo ### inc2734/wp-like-me-box * Source: https://github.com/inc2734/wp-like-me-box ### inc2734/wp-pure-css-gallery * Source: https://github.com/inc2734/wp-pure-css-gallery ### inc2734/wp-awesome-widgets * Source: https://github.com/inc2734/wp-awesome-widgets ### inc2734/wp-awesome-compponents * Source: https://github.com/inc2734/wp-awesome-compponents ## Official goods store https://suzuri.jp/inc2734/products