afifkhaidir / sg-tkpd

SG TKPD is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap Sass

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SG TKPD is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap Sass, that will help you make better themes developement. This theme forked from Sage Theme Starter v8.5.0. For Better bugs tracking you can open new issue https://github.com/riobahtiar/sg-tkpd/issues

Requirements

Prerequisite How to check How to install
PHP >= 5.4.x php -v php.net
Node.js >= 4.5 node -v nodejs.org
gulp >= 3.8.10 gulp -v npm install -g gulp
Bower >= 1.3.12 bower -v npm install -g bower

For more installation notes, refer to the Install gulp and Bower section in this document.

Features

  • gulp build script that compiles both Sass and Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files
  • BrowserSync for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing
  • Bower for front-end package management
  • asset-builder for the JSON file based asset pipeline
  • Bootstrap 3.7.0
  • Theme wrapper
  • ARIA roles and microformats
  • Posts use the hNews microformat
  • Multilingual ready and over 30 available community translations

Install the Soil plugin to enable additional features:

  • Cleaner output of wp_head and enqueued assets
  • Cleaner HTML output of navigation menus
  • Root relative URLs
  • Nice search (/search/query/)
  • Google CDN jQuery snippet from HTML5 Boilerplate
  • Google Analytics snippet from HTML5 Boilerplate

Theme installation

Install This theme using git.

# @ tkpd.dev/site/web/app/themes/
$ git clone git@github.com:riobahtiar/sg-tkpd.git theme-name

Theme setup

Edit lib/setup.php to enable or disable theme features, setup navigation menus, post thumbnail sizes, post formats, and sidebars.

Theme development

Sage uses gulp as its build system and Bower to manage front-end packages.

Install gulp and Bower

Building the theme requires node.js. We recommend you update to the latest version of npm: npm install -g npm@latest.

From the command line:

  1. Install gulp and Bower globally with npm install -g gulp bower
  2. Navigate to the theme directory, then run npm install
  3. Run bower install
  4. Don't forget to remove .git folder. For new project

Yeyyy, ou now have all the necessary dependencies to run the build process.

Available gulp commands

  • gulp — Compile and optimize the files in your assets directory
  • gulp watch — Compile assets when file changes are made
  • gulp --production — Compile assets for production (no source maps).

Using BrowserSync

To use BrowserSync during gulp watch you need to update devUrl at the bottom of assets/manifest.json to reflect your local development hostname.

For example, if your local development URL is http://project-name.dev you would update the file to read:

...
  "config": {
    "devUrl": "http://project-name.dev"
  }
...

If your local development URL looks like http://localhost:8888/project-name/ you would update the file to read:

...
  "config": {
    "devUrl": "http://localhost:8888/project-name/"
  }
...

Change Log

1.0: 20 February 2017

  • First time release
  • Update dependencies
  • Change Bootstrap 4.0.0-alpha.4 to Bootstrap 3.7.0 because we will use in production.
  • Add some developer notes

About

SG TKPD is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap Sass


Languages

Language:PHP 60.2%Language:CSS 25.5%Language:JavaScript 14.3%