Standardize header markdown
This commit is contained in:
parent
02ce6258d7
commit
69af444d86
35
README.md
35
README.md
|
@ -1,14 +1,13 @@
|
|||
Start talking: [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/holger1411/understrap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
|
||||
|
||||
UnderStrap WordPress Theme Framework
|
||||
===
|
||||
# UnderStrap WordPress Theme Framework
|
||||
|
||||
Website: [http://understrap.com](http://understrap.com)
|
||||
|
||||
Child Theme Project: [https://github.com/holger1411/understrap-child](https://github.com/holger1411/understrap-child)
|
||||
|
||||
Changelog
|
||||
=
|
||||
## Changelog
|
||||
|
||||
- **0.4.0 Apr. 15th 2016 Pre-Release**
|
||||
- Adding BrowserSync to gulpfile (again thx to @dvlopes)
|
||||
- Preparing the navbar markup so that the current version will work with Bootstrap 3 AND 4
|
||||
|
@ -74,15 +73,15 @@ Changelog
|
|||
|
||||
- **0.1 Dec. 10th 2014 - First commit**
|
||||
|
||||
About
|
||||
=
|
||||
## About
|
||||
|
||||
I’m a huge fan of Underscores, Bootstrap, and Sass. Why not combine these into a solid WordPress Theme Framework?
|
||||
That’s what UnderStrap is (or will be…)
|
||||
|
||||
At the moment, UnderStrap is in a very early stage. But if you wan’t, feel free to use it for your own WordPress theme!
|
||||
|
||||
Basic Features
|
||||
=
|
||||
## Basic Features
|
||||
|
||||
- Combines Underscore’s PHP/JS files and Bootstrap’s HTML/CSS/JS.
|
||||
- Comes with Bootstrap (v3.3.6) Sass source files and additional .scss files. Nicely sorted and ready to add your own variables and customize the Bootstrap variables.
|
||||
- Uses a single and minified CSS file for all the basic stuff.
|
||||
|
@ -94,13 +93,13 @@ Basic Features
|
|||
- [Child Theme](https://github.com/holger1411/understrap-child) ready.
|
||||
- Translation ready.
|
||||
|
||||
Starter theme + HTML framework = WordPress theme framework
|
||||
=
|
||||
## 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? That’s where Bootstrap comes in.
|
||||
|
||||
Confused by all the CSS and Sass files?
|
||||
=
|
||||
## 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.css`file just 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` file provides all styles. It is composed of five different SCSS sets and one variable file at `/sass/theme.scss`:
|
||||
|
@ -116,16 +115,16 @@ Some basics about the Sass and CSS files that come with UnderStrap:
|
|||
- Don’t edit the files no. 2-4 files/filesets or you won’t 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
|
||||
=
|
||||
## Installation
|
||||
|
||||
- Download the understrap folder
|
||||
- Upload it into your WordPress installation subfolder here: `/wp-content/themes/`
|
||||
- Login to your WordPress backend
|
||||
- Go to Appearance → Themes
|
||||
- Activate the UnderStrap theme
|
||||
|
||||
Developing with NPM, Bower, Gulp and SASS and [Browser Sync][1]
|
||||
=
|
||||
## Developing with NPM, Bower, Gulp and SASS and [Browser Sync][1]
|
||||
|
||||
### Installing dependencies
|
||||
- Make sure you have installed Node.js, Bower, and Browser-Sync on your computer globally
|
||||
- Then open your terminal and browse to the location of your UnderStrap copy
|
||||
|
@ -147,8 +146,8 @@ var browserSyncOptions = {
|
|||
```
|
||||
- then run: `$ gulp watch-bs`
|
||||
|
||||
How to use the build-in widget slider
|
||||
=
|
||||
## 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”.
|
||||
|
|
Reference in New Issue