updating docs

This commit is contained in:
koenemann 2015-08-21 15:11:53 +02:00
parent ba9c9104f5
commit 57d6fab17d
2 changed files with 15 additions and 17 deletions

View File

@ -42,7 +42,7 @@ At the moment UnderStrap is in a very early stage. But if you wan´t feel free t
Basic Features Basic Features
= =
- Combines the _s Wordpress Starter Theme and Bootstrap - Combines the _s Wordpress Starter Theme PHP/JS files and Bootstrap´s HTML/CSS/JS
- Comes with Bootstrap SASS source files and additional scss files. Nicely sorted and ready to add your own variables/customize the Bootstrap variables. - Comes with Bootstrap SASS source files and additional scss files. Nicely sorted and ready to add your own variables/customize the Bootstrap variables.
- Uses a single and minified CSS file for all the basic stuff - Uses a single and minified CSS file for all the basic stuff
- Font Awesome Icon Font integrated (V 4.2.0): http://fortawesome.github.io/Font-Awesome/ - Font Awesome Icon Font integrated (V 4.2.0): http://fortawesome.github.io/Font-Awesome/
@ -61,19 +61,17 @@ Confused by all the CSS and SCSS files?
= =
Some basics about the SCSS and CSS files comes with UnderStrap: Some basics about the SCSS and CSS files comes with UnderStrap:
- The theme itself uses the style.css in the root directory just to identify the theme inside of Wordpress. The file is not loaded by the theme and did not include any styles - The theme itself uses the style.css in the root directory just to identify the theme inside of Wordpress. The file is not loaded by the theme and did not include any styles
- The theme.css file in /css/ subdirectory provides all styles. It is composed by six different SCSS sets and one variables file from /sass/ directory: - The theme.css file in /css/ subdirectory provides all styles. It is composed by five different SCSS sets and one variables file from /sass/theme.scss:
1./sass/underscores/understrap_underscores.scss (<- Basics for the _s theme) - 1 "theme/theme_variables"; // <--------- Add your variables into this file. Also add variables to overwrite Bootstrap or UnderStrap variables here
2./sass/bootstrap/understrap_bootstrap.scss (<- which imports all Bootstrap SCSS files and mixins from /sass/bootstrap/ directory) - 2 "../bower_components/bootstrap-sass/assets/stylesheets/bootstrap"; // <--------- All the Bootstrap stuff - Don´t edit this!
3./sass/understrap/understrap.scss (<- Just used minimal styles to combine _s and Bootstrap aand the other assets nicely) - 3 "understrap/understrap"; // <--------- Some basic WordPress stylings and needed styles to combine Boostrap and Underscores
4./sass/font-awesome/understrap_font-awesome.scss (<-imports all Font Awesome icons and the font itself) - 4 "../bower_components/fontawesome/scss/font-awesome"; // <--------- Font Awesome Icon styles
--------------- Don´t edit the files above ---------------
5./sass/theme/theme.scss (<- Thats your part! Here you can add your own style)
and
6.sass/theme/_theme_variables.scss (<- here you can define own variables or you could overwrite existing Bootstrap variables easily without touching the original BS code)
- Don´t edit the first four files/filesets or you aren´t able to update it without overwriting your own work! // Any additional imported files //
- 5 "theme/theme"; // <--------- Add your styles into this file
- Don´t edit the files no. 2-4 files/filesets or you aren´t able to update it without overwriting your own work!
- Your design goes into: /sass/theme directory. Add your styles to the theme.scss file and your variables to the _theme_variables.scss. Or add other scss files into it and @import it into theme.scss - Your design goes into: /sass/theme directory. Add your styles to the theme.scss file and your variables to the _theme_variables.scss. Or add other scss files into it and @import it into theme.scss
Installation Installation

View File

@ -1,15 +1,15 @@
/***************************************************************** /*****************************************************************
Import all needed 3rd party sass files plus your own style and variables Import all needed 3rd party sass files plus your own style and variables
1. ../bower_components/_s/sass/style // Adding underscores default styles. Don´t needed if you use Bootstrap for styling 0. ../bower_components/_s/sass/style // Adding underscores default styles. Don´t needed if you use Bootstrap for styling
-------------------------------------- --------------------------------------
2. theme/theme_variables.scss // Overwriting Bootstrap variables and for own variables <-- ADD YOUR VARIABLES HERE 1. theme/theme_variables.scss // Overwriting Bootstrap variables and for own variables <-- ADD YOUR VARIABLES HERE
-------------------------------------- --------------------------------------
3.../bower_components/bootstrap-sass/assets/stylesheets/bootstrap // adding bootstrap from bower components folder. Make sure you run bower install before! <- Dont edit this files! 2.../bower_components/bootstrap-sass/assets/stylesheets/bootstrap // adding bootstrap from bower components folder. Make sure you run bower install before! <- Dont edit this files!
-------------------------------------- --------------------------------------
4. understrap/understrap.scss // Some basic understrap styles. Helps to combine Bootsrap and _s theme and provides some basic styleing for additonal functions <- Dont edit this files! 3. understrap/understrap.scss // Some basic understrap styles. Helps to combine Bootsrap and _s theme and provides some basic styleing for additonal functions <- Dont edit this files!
-------------------------------------- --------------------------------------
5. ../bower_components/fontawesome/scss/font-awesome <- Dont edit this files! If you don´t need/want Font Awesome support comment out this line 4. ../bower_components/fontawesome/scss/font-awesome <- Dont edit this files! If you don´t need/want Font Awesome support comment out this line
-------------------------------------- --------------------------------------