This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Thomas A. Reinert 317c3d80e4 Adding formal German language. See #670 2018-05-16 15:48:01 +02:00
css Update to Bootstrap 4.1 and rebuild 2018-04-10 19:05:24 +02:00
fonts update changelog to 0.81 2018-03-07 11:08:50 +01:00
global-templates Adding the herocanvas widget position 2018-04-13 20:19:33 +02:00
inc Merge pull request #666 from 0dp/gulp-rev - thx @0dp 2018-05-15 15:02:14 +02:00
js Dependency updates and rebuild 2018-04-11 11:27:24 +02:00
languages Adding formal German language. See #670 2018-05-16 15:48:01 +02:00
loop-templates phpcs fixes. 2017-04-15 21:44:32 +09:30
page-templates Fix wrong escaping functions - replacing esc_html() with esc_attr() 2017-06-08 17:54:29 +03:00
sass Update to Bootstrap 4.1 and rebuild 2018-04-10 19:05:24 +02:00
src Update to Bootstrap 4.1 and rebuild 2018-04-10 19:05:24 +02:00
woocommerce Fixing text domain - changed from woo commerce to understrap 2018-04-11 11:55:35 +02:00
.gitignore Update .gitignore 2018-04-20 15:40:49 +02:00
.jscsrc exclude gulpfile.js from Travis checks 2018-03-07 13:32:41 +01:00
.jshintignore adding gulp file.js to jshintignore 2018-03-07 13:36:16 +01:00
.travis.yml and again 2018-03-07 12:04:51 +01:00
404.php Fixing this issue: https://github.com/holger1411/understrap/issues/392 2017-08-22 09:04:58 +02:00
CHANGELOG.md Preparing 0.8.2 release 2018-04-11 11:40:00 +02:00
CODE-OF-CONDUCT.md Needs change of Mail-address. Inserted mine as a temporary workaround to make (anonymous) complaints possible. Should be set to the repo´s maintainer. 2018-03-16 02:24:42 +01:00
CONTRIBUTING.md Add CONTRIBUTING.md for review 2018-03-16 02:36:03 +01:00
ISSUE_TEMPLATE.md - Updated URL to understrap-child in README. 2018-04-24 17:37:04 -04:00
LICENSE.md Create LICENSE.md 2018-03-17 21:26:48 +01:00
README.md - Updated URL to understrap-child in README. 2018-04-24 17:37:04 -04:00
archive.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
author.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
bower.json Preparing 0.8.2 release 2018-04-11 11:40:00 +02:00
codesniffer.ruleset.xml Update codesniffer.ruleset.xml 2017-08-14 17:30:16 +03:00
comments.php Update comments.php 2017-12-28 14:35:34 +05:30
composer.json Change type of package to wordpress-theme 2018-04-11 21:48:02 +02:00
footer.php Markup alignments and changeling update for 0.6.3 update 2017-08-14 13:31:10 +02:00
functions.php Swap customized walker to latest upstream wp-bootstrap-navwalker class 2018-04-17 17:08:26 +01:00
gulpconfig.json wrapping imagemin in a watcher to insure it finishes 2018-02-19 21:29:16 -06:00
gulpfile.js gulp-rev 2018-05-02 12:27:12 +02:00
header.php Modify walker with 'understarp' prefixed on class name and as textdomain 2018-04-17 17:18:34 +01:00
index.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
package.json Dependency updates and rebuild 2018-04-11 11:27:24 +02:00
page.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
readme.txt Fixing sanitizing, escaping and prefix´s issues 2017-12-06 10:20:33 +01:00
screenshot.png adding new screenshot 2018-04-13 20:45:25 +02:00
search.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
searchform.php Updated the markup for input groups according to BS 4 changes 2018-03-03 19:09:49 +00:00
sidebar-footerfull.php Fix wrong escaping functions - replacing esc_html() with esc_attr() 2017-06-08 17:54:29 +03:00
sidebar-hero.php Removing span duplicate 2017-12-08 14:29:57 +01:00
sidebar-herocanvas.php aha, and removing the outer wrapper 2018-04-13 20:24:58 +02:00
sidebar-left.php escape variables from potential unsecure input 2016-11-19 19:43:22 +02:00
sidebar-right.php escape variables from potential unsecure input 2016-11-19 19:43:22 +02:00
sidebar-statichero.php Fix wrong escaping functions - replacing esc_html() with esc_attr() 2017-06-08 17:54:29 +03:00
sidebar.php root files code format 2016-11-21 20:47:05 +02:00
single.php Moving closing primary </div> into right-sidebar-check.php for more clearness - Thx @jack-fdrv 2018-04-12 20:35:08 +02:00
style.css Fixing URI´s 2018-05-12 23:45:56 +02:00

README.md

Travis build: Build Status

See: Official Demo | Read: Official Docs Page

UnderStrap WordPress Theme Framework

Website: https://understrap.com

Child Theme Project: https://github.com/understrap/understrap-child

About

Im a huge fan of Underscores, Bootstrap, and Sass. Why not combine these into a solid WordPress Theme Framework? Thats what UnderStrap is. You can use it as starter theme and build your own theme on top of it. Or you can use it as a parent theme and create your own child theme for UnderStrap.

License

UnderStrap WordPress Theme, Copyright 2013-2017 Holger Koenemann UnderStrap is distributed under the terms of the GNU GPL version 2

http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html

Changelog

See changelog

Basic Features

  • Combines Underscores PHP/JS files and Bootstraps HTML/CSS/JS.
  • Comes with Bootstrap (v4) Sass source files and additional .scss files. Nicely sorted and ready to add your own variables and customize the Bootstrap variables.
  • Uses a single minified CSS file for all the basic stuff.
  • Font Awesome integration (v4.7.0)
  • Jetpack ready.
  • WooCommerce support.
  • Contact Form 7 support.
  • Child Theme ready.
  • Translation ready.

Starter Theme + HTML Framework = WordPress Theme Framework

The _s theme is a good starting point to develop a WordPress theme. But it is “just” a raw starter theme. That means it outputs all the WordPress stuff correctly but without any layout or design. Why not add a well known and supported layout framework to have a solid, clean and responsive foundation? Thats where Bootstrap comes in.

Confused by All the CSS and Sass Files?

Some basics about the Sass and CSS files that come with UnderStrap:

  • The theme itself uses the /style.cssfile only to identify the theme inside of WordPress. The file is not loaded by the theme and does not include any styles.
  • The /css/theme.css and its minified little brother /css/theme.min.css file(s) provides all styles. It is composed of five different SCSS sets and one variable file at /sass/theme.scss:
@import "../src/bootstrap-sass/assets/stylesheets/bootstrap";  // 2. All the Bootstrap stuff - Don´t edit this!
@import "understrap/understrap"; // 3. Some basic WordPress stylings and needed styles to combine Boostrap and Underscores
@import "../src/fontawesome/scss/font-awesome"; // 4. Font Awesome Icon styles
// Any additional imported files //
@import "theme/theme";  // 5. Add your styles into this file
  • Dont edit the files no. 2-4 files/filesets or you wont be able to update it without overwriting your own work!
  • Your design goes into: /sass/theme.
    • Add your styles to the /sass/theme/_theme.scss file
    • And your variables to the /sass/theme/_theme_variables.scss
    • Or add other .scss files into it and @import it into /sass/theme/_theme.scss.

Installation

Classic install

  • Download the understrap folder from GitHub or from https://understrap.com
  • IMPORTANT: If you download it from GitHub make sure you rename the "understrap-master.zip" file just to "understrap.zip" or you might have problems using child themes!
  • Upload it into your WordPress installation subfolder: /wp-content/themes/
  • Login to your WordPress backend
  • Go to Appearance → Themes
  • Activate the UnderStrap theme

npm install

  • Open your terminal
  • Change to the directory where you want to add UnderStrap
  • Type npm install understrap

WordPress.org install

  • Open your WordPress backend
  • Click on "Appearance -> Themes"
  • Hit the "Add new" button
  • Search for "UnderStrap"
  • Hit the "install" button
  • Activate the theme

Developing With npm, Gulp and SASS and [Browser Sync][1]

Installing Dependencies

  • Make sure you have installed Node.js and Browser-Sync (optional) on your computer globally
  • Then open your terminal and browse to the location of your UnderStrap copy
  • Run: $ npm install

Running

To work with 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 /gulpconfig.json in the beginning of the file:
{
    "browserSyncOptions" : {
        "proxy": "localhost/theme_test/", // <----- CHANGE HERE
        "notify": false
    },
    ...
};
  • then run: $ gulp watch-bs

How to Use the Build-In Widget Slider

The front-page slider is widget driven. Simply add more than one widget to widget position “Hero”.

  • Click on Appearance → Widgets.
  • Add two, or more, widgets of any kind to widget area “Hero”.
  • Thats it.

RTL styles?

Add a new file to the themes root folder called rtl.css. Add all alignments to this file according to this description: https://codex.wordpress.org/Right_to_Left_Language_Support

Page Templates

Blank Template

The blank.php template is useful when working with various page builders and can be used as a starting blank canvas.

Empty Template

The empty.php template displays a header and a footer only. A good starting point for landing pages.

Full Width Template

The fullwidthpage.php template has full width layout without a sidebar.

Footnotes

[1] Visit http://browsersync.io for more information on Browser Sync

Licenses & Credits

Analytics