Merge pull request #128 from sourcejs/0.5.1-rc

0.5.1 rc

Author: robhrt7

README.md

@@ -15,23 +15,25 @@ Our main goal is to provide flexible, modular environment for managing reusable
 ___
 
 
-[**Source engine project page**](http://sourcejs.com)     [**Documentation**](http://sourcejs.com/docs)     [**Quick Start**](http://sourcejs.com/docs/base)     [**Examples**](http://sourcejs.com/docs/base/#examples)    [**FAQ**](https://github.com/sourcejs/Source/issues?q=is%3Aissue+label%3Afaq+)    
+[**Source engine project page**](http://sourcejs.com)     [**Documentation**](http://sourcejs.com/docs)     [**Quick Start**](http://sourcejs.com/docs/base)     [**Examples**](http://sourcejs.com/docs/base/#examples)    [**How-to's**](https://github.com/sourcejs/blog-howto)
 
 ___
 
 SourceJS component management engine was originally developed in [OK.ru](http://corp.mail.ru/en/communications/odnoklassniki) front-end development team and is recommended for big and middle sized projects. Especially for fast growing web portals, outsource teams with similar project and companies with multiple services.
 
-## Things that SourceJS is NOT
+## SourceJS is NOT
+
+To clear some confusion around Living Style Guide Platforms comparison, let us define few main differences.
 
 ### Static site builder
 
 **SourceJS is a dynamic Node.js application**, and does not build static website as Pattern Lab, KSS, StyleDocco are doing. Dynamic environment allows to connect unlimited number of plugins and middlewares for compiling docs, styles, text right on the flight.
 
 ### CSS Documentation parser
 
-Engine is based on gathering special documentation files (`index.src` by default), where you leave your HTML examples, template calls and description. All Specs are located in `sourcejs/user/specs` folder, and could contain any catalogue structure, with focus on component folders.
+Engine is based on gathering special documentation templates (`index.src`, `readme.md` and others), where you leave your HTML examples, template includes and description. All Specs are located in `sourcejs/user/specs` folder, and could contain any catalogue structure, with focus on component folders.
 
-**But** engine will support [DSS](https://github.com/darcyclarke/DSS) as a plugin, which is universal CSS Documentation parser. So it will be possible to document your components both in CSS, Markdown and native `index.src`.
+**But** you can use official SourceJS plugin based on DSS, CSS Documentation parser - https://github.com/sourcejs/sourcejs-contrib-dss.
 
 ## Join the community
 
@@ -40,7 +42,8 @@ Many teams are already using SourceJS for building and managing Front-end compon
 If you notice some bugs, or need to help finding a better solution in your process, feel free to create an issue, and we will solve your problem together.
 
 ## Updates
-* 15.03.15. New example [Specs showcase](http://sourcejs.com/specs/examples/) ([source code](https://github.com/sourcejs/examples)) 
+* 28.03.15. SourceJS [Bootstrap example bundle](https://github.com/sourcejs/example-bootstrap-bundle) and [How-to articles blog](https://github.com/sourcejs/blog-howto)
+* 15.03.15. New example [Specs showcase](http://sourcejs.com/specs/examples/) ([source code](https://github.com/sourcejs/examples))
 * 15.03.15. CSS Documentation support with DSS https://github.com/sourcejs/sourcejs-contrib-dss
 * 12.03.15. **[0.5.0](https://github.com/sourcejs/Source/releases/tag/0.5.0) release** with full Markdown support, GitHub auth, `info.json` watchers and other improvements
 * 24.02.15. [0.4.1](https://github.com/sourcejs/Source/releases/tag/0.4.1) patch release
@@ -52,17 +55,25 @@ If you notice some bugs, or need to help finding a better solution in your proce
 * 31.07.14. 0.4.0-beta release
 * 01.05.14. Engine presentation from [Front-end Ops Conf](http://www.feopsconf.com/), San Francisco - [Taking Development Tools To The Next Level](http://rhr.me/pres/ime/) with [video](https://www.youtube.com/watch?v=cMIad0zl00I)
 * 31.01.14. [Preview](http://youtu.be/cefy_U5NU4o) of Source companion tool for prototyping interfaces using existing components
-* 31.12.13. **0.3.2** release
+* 31.12.13. **0.3.2 release**
 * 09.10.13. Engine [presentation](http://rhr.me/pres/source-min/) on [Fronteers Jam](http://fronteers.nl/congres/2013/jam-session) ([video](https://vimeo.com/77989211))
 * 23.09.13. Published [video recording](http://www.youtube.com/watch?v=3HNW5Bru0Ws) of Source engine presentation from [RIT++](http://ritconf.ru/) 2013 (RU)
 
 ## Upcoming updates
 
-* Support of multiple documentation projects in one environment
-* Screencasts and engine usage demos
-* Full english documentation stack for core API
-* Test coverage
-* Stable v1.0.0 version
+Respecting open source community, we track all our tasks publicly on GitHub. Follow our [milestones](https://github.com/sourcejs/example-bootstrap-bundle) and twitter announcements [@SourceJS](http://sourcejs.com) to keep in sync with latest plans.
+
+List of few global upcoming features
+
+* Refactored code snippets API
+* Integrations with JSDoc and drop-in replacement setup for other Style Guide tools like KSS/Pattern Lab
+* More screencasts and engine usage demos
+* Wider support of multiple documentation projects in one environment
+* Full documentation stack for core API for writing plugins
+
+SourceJS follows semantic versioning and we do our best to keep as less breaking changes as possible.
+
+Preparing to 1.0 release, we plan to keep migration path very smooth and painless. So if you will keep in sync with minor releases and API deprecation announcements, you won't face any problems setting up major release updates.
 
 ## Useful information
 

app.js

@@ -151,7 +151,7 @@ try {
 
 
 // Watchers
-if (global.opts.core.watch.enabled && global.MODE !== 'presentation') {
+if (global.opts.core.watch.enabled && global.MODE === 'development') {
     require('./core/watchNewSpecs');
 }
 
@@ -187,7 +187,7 @@ var logErrors = function(err, req, res, next) {
         var url = req.url || '';
 
         log.debug(req.method, req.headers);
-        log.error(url.red, ('Error: ' + err.stack).red);
+        log.error(('Requested url: ' + url).red, ('Error: ' + err.stack).red);
 
         if (req.xhr) {
             res.status(500).json({msg: 'Server error'});

assets/css/base/grids.less

@@ -12,7 +12,7 @@
 	display: inline-block;
 
 	vertical-align: top;
-	width: 33.1%;
+	width: 33%;
 	padding-right: 25px;
 
 	box-sizing: border-box;

assets/css/cosmetic/highlights.less

@@ -5,7 +5,7 @@
     background: @light-gray;
     font-family: Menlo, Monaco, Consolas, monospace;
     font-size: .85em;
-    padding: 2px 4px 1px;
+    padding: 0 3px;
     border-radius: 3px;
     border: 1px solid #dfe2e4;
     white-space: normal;

assets/css/project/catalog.less

@@ -15,12 +15,24 @@
     font-size: @fz-size-m;
     line-height: 1.5;
 
+    color: @gray !important;
+
     &_h2,
     h2 {
+        line-height: 1.5 !important;
         font-size: 22px !important;
         color: @black !important;
         margin: 20px 0 5px 0 !important;
         font-weight: normal !important;
+
+        a {
+            color: @black;
+            text-decoration: underline;
+
+            &:hover {
+                text-decoration: none;
+                }
+            }
         }
 
     &.__show-preview {
@@ -55,6 +67,7 @@
         }
     }
 
+.source_catalog > p,
 .source_catalog_tx {
 	margin: 0 0 20px !important;
 
@@ -70,6 +83,7 @@
 		}
 	}
 
+.source_subhead > p,
 .source_subhead .source_catalog_tx {
     margin: 0 0 10px !important;
     min-height: 0;

assets/css/project/clarify-in-spec.less

@@ -2,16 +2,17 @@
     display: block !important;
     width: 18px;
     height: 18px;
-    background: url("/source/assets/i/link-external.svg") !important;
-    background-size: 100% 100% !important;
+    background: url("/source/assets/i/link-external.svg") 50% no-repeat !important;
+    background-size: contain !important;
     float: right !important;
     margin-right: -15px !important;
     margin-top: 5px !important;
     }
 
 .source_section > h3 > .source_clarify-in-spec_link {
-    width: 26px;
+    width: 27px;
     margin-top: 3px !important;
+    margin-right: -19px !important;
     background-color: #fff !important;
     z-index: 1 !important;
     position: relative !important;

assets/css/project/info.less

@@ -29,6 +29,14 @@
 			margin-bottom: 0 !important;
 			}
 		}
+
+    th, td {
+        border-color: #868686 !important;
+        }
+
+    > *:last-child {
+        margin-bottom: 0 !important;
+        }
     }
 
 .source_info {
@@ -37,55 +45,80 @@
 	padding: 15px 25px !important;
 	min-height: 50px !important;
 	margin: 15px 0 !important;
-	margin-right: @layout_spec--inner-margin-right !important;
+
+    @media @media_min-step-m {
+	    margin-right: @layout_spec--inner-margin-right !important;
+        }
 
     .source_section & {
         margin-right: 0 !important;
         }
 	}
 
 .source_warn {
-	margin: 20px @layout_spec--inner-margin-right 20px 0 !important;
+	margin: 20px 0 !important;
 	padding: 10px 10px 10px 35px !important;
 
 	background: #ffe2e5 url(/source/assets/i/warn.png) no-repeat 13px 13px !important;
 
+    @media @media_min-step-m {
+        margin-right: @layout_spec--inner-margin-right !important;
+        }
+
     .source_section & {
         margin-right: 0 !important;
         }
 	}
 
 .source_note {
-    margin: 20px @layout_spec--inner-margin-right 20px 0 !important;
+    margin: 20px 0 !important;
     padding: 10px 10px 10px 35px !important;
 
     background: #DCF1FA url(/source/assets/i/note.png) no-repeat 13px 13px !important;
 
+    @media @media_min-step-m {
+        margin-right: @layout_spec--inner-margin-right !important;
+        }
+
     .source_section & {
         margin-right: 0 !important;
         }
     }
 
 .source_doc {
-    margin: 20px @layout_spec--inner-margin-right 20px 0 !important;
+    margin: 20px 0 !important;
     padding: 10px 25px !important;
 
     background: #DCFCDA !important;
     font-family: Menlo, Monaco, Consolas, monospace !important;
 
+    @media @media_min-step-m {
+        margin-right: @layout_spec--inner-margin-right !important;
+        }
+
+    & code,
+    & p {
+        font-family: Menlo, Monaco, Consolas, monospace !important;
+        }
+
     .source_section & {
         margin-right: 0 !important;
         }
     }
 
 .source_data {
-    margin: 20px @layout_spec--inner-margin-right 20px 0 !important;
+    margin: 20px 0 !important;
     padding: 10px 25px !important;
 
     border: 1px dotted #ccc !important;
     background: #f9f9f9 !important;
     font-size: 11px !important;
 
+
+    @media @media_min-step-m {
+        margin-right: @layout_spec--inner-margin-right !important;
+        }
+
     .source_section & {
         margin-right: 0 !important;
         }

assets/css/project/layout.less

@@ -75,6 +75,7 @@
 
     font-family: @font-family-main;
     font-size: @fz-size-m;
+	color: @gray;
     line-height: 1.5;
 
     // Clearfix

assets/css/project/navigation.less

@@ -88,13 +88,12 @@
 .source_main_nav_li2 {
 	color: #666;
 	overflow: hidden;
+	display: none;
 	text-overflow: ellipsis;
 	white-space: nowrap;
-	line-height: 0;
-	transition: line-height 0.2s;
 	}
 	.source_main_nav_li.__active .source_main_nav_li2 {
-		line-height: 20px;
+		display: block;
 		}
 
 .source_nav_ul .source_main_nav_a {

assets/css/project/section.less

@@ -86,39 +86,9 @@
 		margin: 15px 0;
 		}
 
-	& > table {
-		margin: 20px 0 30px;
-		border-collapse: collapse;
-		border-spacing: 0;
-		font-size: @fz-size-m;
-		font-family: @font-family-main;
-		line-height: 1.5;
-		}
-
-	& > table td,
-	& > table th {
-		padding: 0;
-		}
-
-	& > table th,
-	& > table td {
-		padding: 6px 13px;
-		border: 1px solid #ddd;
-		}
-
-	& > table th,
-	& > table td {
-		padding: 6px 13px;
-		border: 1px solid #ddd;
-		}
-
 	& > pre {
 		.reset();
 		}
-
-	& > table tr {
-		border-top: 1px solid #ccc;
-		}
 	}
 
 /* Dynamics