kril-theme/README.md

62 lines
2.3 KiB
Markdown
Raw Normal View History

2016-03-23 11:18:13 +02:00
# understrap-child
Basic Child Theme for UnderStrap Theme Framework: https://github.com/holger1411/understrap
2016-05-04 00:05:25 +03:00
## How it works
2016-03-23 11:18:13 +02:00
It shares with the parent theme all PHP files and adds its own functions.php on top of the UnderStrap parent themes functions.php.
IT DIT NOT LOAD THE PARENT THEMES CSS FILE(S)!
Instead it uses the UnderStrap Parent Theme as dependency via Bower and compiles its own CSS file from it.
Uses the Enqueue method the load and sort the CSS file the right way instead of the old @import methode
2016-05-04 00:05:25 +03:00
## Installation
2016-03-23 11:18:13 +02:00
1. Install the parent theme UnderStrap first: https://github.com/holger1411/understrap
2. Just upload the understrap-child folder to your wp-content/themes directory
3. Go into your WP admin backend
4. Go to "Appearance -> Themes"
5. Activate the UnderStrap Child theme
2016-05-04 00:05:25 +03:00
## Editing
2016-03-23 11:18:13 +02:00
Add your own CSS styles to /sass/theme/_child_theme.scss
ot import you own files into /sass/theme/understrap-child.scss
To overwrite Bootstrap or UnderStraps base variables just add your own value to:
/sass/theme/_child_theme_variables.scss
For example:
the "$brand-primary" variable is used by both, Bootstrap and UnderStrap.
Add your own color like:
$brand-primary: #ff6600;
in /sass/theme/_child_theme_variables.scss to overwrite it.
That will change automatically all elements who use this variable.
It will be outputted into:
/css/understrap-child.min.css
and
/css/understrap-child.css
2016-05-04 00:05:25 +03:00
So you have one clean CSS file at the end and just one request.
## Developing With NPM, Bower, Gulp, SASS and Browser Sync
### Installing Dependencies
- Make sure you have installed Node.js, Bower, and Browser-Sync [1] on your computer globally
- Then open your terminal and browse to the location of your UnderStrap copy
- Run: `$ npm install` then: `$ bower install` and finally: `$ gulp copy-assets`
### Running
To work and compile your Sass files on the fly start:
- `$ gulp watch`
Or, to run with Browser-Sync:
- First change the browser-sync options to reflect your environment in the file `/gulpfile.js` in the beginning of the file:
```javascript
var browserSyncOptions = {
proxy: "localhost/theme_test/", // <----- CHANGE HERE
notify: false
};
```
- then run: `$ gulp watch-bs`
[1] Visit [http://browsersync.io](http://browsersync.io) for more information on Browser Sync