Commit 16d2643a authored by maikelkoopman's avatar maikelkoopman
Browse files

DS-4197 by maikelkoopman: update documentation in socialbase

parent 34bbbc31
### Release 1.5
* Updated Gulptasks.
* All 3rd party libraries are removed from the theme and need to be included via composer (or drush). Libraries now refer to files in html/libraries folder.
* Gulp task `minify-js` has been removed and the `scripts` task has been added.
* All gulp plugins are updated to the latest version.
### Release 1.4
* Moved rounded avatars style from socialbase to socialblue. For existing installations: Add border-radius properties to base/utilities/images, atoms/list and molecules/navigation/navbar components in your subtheme to keep rounded styles.
### v2.1.4 -- May 2017
* Added method for autogrow behaviour and changed event triggers.
* Changed overflow styles for autogrow form elements.
......
# Base theme #
The Social Base theme is designed as a base theme for Open Social. This base theme holds has a lot of sensible defaults. It doesn't however contain much styling. We expect every developer to want to change this for his/her project. As you can see there is also a theme called **socialblue**. Socialblue is the demo/styling sub theme for Open Social.
The Social Base theme is designed as a base theme for Open Social. This base theme holds has a lot of sensible defaults. However, it doesn't contain much styling. We expect every developer to want to change this for his/her project. As you can see there is also a theme called **socialblue**. Socialblue is the demo/styling sub theme for Open Social.
# Changing the style of the theme #
If you are a Drupal themer you know how to create a (sub)theme. There are no tricks in our setup you need to know for Open Social. The easiest way to start is to grab a copy of Social Blue and rename all instances of social Blue to your new theme name. Social Base and Social Blue will get updates each release, so it is best not to make changes in here you want to keep.
......@@ -31,12 +31,8 @@ If you are a Drupal themer you know how to create a (sub)theme. There are no tri
<dd>This is working folder. The folder is categorised following atomic design principles. Most re-usable css values are turned into variables for consistency.</dd>
<dt># config</dt>
<dd>Drupal installation files</dd>
<dt># js - deprecated</dt>
<dd>Old javascript folder, needs to cleaned up (all JS should be in components are generated to assets folder)</dd>
<dt># libraries</dt>
<dd>External libraries. Install via Gulp Bower task.</dd>
<dt># src</dt>
<dd>Drupal plugins - mainly overrides for the bootstrap base theme. @see [Drupal Bootstrap documentation](https://drupal-bootstrap.org/api/bootstrap/docs%21plugins%21README.md/group/plugins/8)</dd>
<dd>Drupal plugins - contains most functions and template suggestions. @see [Drupal Bootstrap documentation](https://drupal-bootstrap.org/api/bootstrap/docs%21plugins%21README.md/group/plugins/8) on how to extend this in your subtheme.</dd>
<dt># Templates</dt>
<dd>This folder contains all twig templates for the theme.</dd>
......@@ -45,7 +41,7 @@ If you are a Drupal themer you know how to create a (sub)theme. There are no tri
# Contributing to socialbase #
Social Base uses Gulp.js as a task runner, so that it can do many tasks automatically:
- Build CSS from your Sass using libSass and node-sass.
- Build CSS from your Sass.
- Add vendor prefixes for the browsers you want to support using Autoprefixer.
- Watch all of your files as you develop and re-build everything on the fly.
......@@ -80,6 +76,5 @@ Set up your front-end development build tools:
# Notice
We are constantly improving and updating the theme setup for Open Social. It might be the readme is not always up to date. Also check the changelog file for changes. You can report issues via the drupal.org [issue queue](https://www.drupal.org/project/issues/social?categories=All). The following items are on our roadmap:
* Remove JS folder and make sure all scripts are placed in their corresponding component.
* Add components library module and create twig templates in the components folder.
* Provide a starterkit in favor a manual copying Social Blue to start a new theme.
......@@ -94,14 +94,13 @@ gulp.task('styles', ['clean:css'], function () {
// #################
//
// Compile the Sass
// Compile the Javascript
//
// #################
//
// This task will look for all scss files and run postcss and rucksack.
// For performance review we will display the file sizes
// Then the files will be stored in the assets folder
// At the end we check if we should inject new styles in the browser
// This task will look for all js files, minifies theme
// and puts them in assets folder. When browsersync is enabled
// the browser will fetch the changes.
// ===================================================
gulp.task('scripts', ['clean:js'], function () {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment