Merge branch 'master' into fix/212/bit-docs-html-canjs

Author: jamiemccue

.gitignore

@@ -3,3 +3,4 @@ temp/
 index.html
 .vscode
 *.log
+.DS_Store

bit-docs.js

@@ -1,4 +1,5 @@
 var path = require("path");
+var tags = require('./tags/tags');
 
 module.exports = function(bitDocs){
     var pkg = require("./package.json");
@@ -9,4 +10,6 @@ module.exports = function(bitDocs){
         templates: path.join(__dirname, "templates"),
         dependencies: dependencies
     });
-}
+
+    bitDocs.register("tags", tags);
+}

docMap.json

@@ -1,22 +1,25 @@
 var generate = require("bit-docs-generate-html/generate");
+var generateSearchMap = require("bit-docs-generate-searchmap/generate");
 var Q = require("q");
 var fs = require("fs");
 var readFile = Q.denodeify(fs.readFile);
 var path = require("path");
 
+var forceBuild = process.argv.indexOf("-f") !== -1;
+
 var docMap = readFile(__dirname+"/docMap.json").then(function(source){
     return JSON.parse(""+source);
 });
-
-var forceBuild = process.argv.indexOf("-f") !== -1;
-
-generate(docMap,{
+var siteConfig = {
     html: {
         templates: path.join(__dirname, "templates"),
         dependencies: {
             "bit-docs-html-canjs": __dirname,
             "bit-docs-prettify": "^0.1.0",
-			"bit-docs-html-highlight-line": "^0.2.2"
+			"bit-docs-html-highlight-line": "^0.2.2",
+			//TODO: This should not be include here and should only be included in package.json.
+			//  we get an error without this, here, though
+			"steal-stache": "^3.0.1"
         }
     },
     dest: path.join(__dirname, "temp"),
@@ -27,4 +30,8 @@ generate(docMap,{
 		"2.3.27": "https://v2.canjs.com"
 	},
     debug: true
+};
+
+generate(docMap,siteConfig).then(function(){
+	return generateSearchMap(docMap, siteConfig);
 }).done();

make-example.js

@@ -1,6 +1,6 @@
 {
   "name": "bit-docs-html-canjs",
-  "version": "0.4.14",
+  "version": "0.6.0",
   "description": "The plugins to produce the CanJS site",
   "main": "static/canjs",
   "scripts": {
@@ -27,13 +27,18 @@
   "homepage": "https://github.com/canjs/bit-docs-html-canjs#readme",
   "system": {},
   "dependencies": {
+    "can-control": "^3.0.3",
+    "can-util": "^3.0.10",
     "escape-html": "^1.0.3",
     "jquery": "^2.2.4",
     "lodash": "^4.17.4",
+    "lunr": "^2.0.3",
+    "steal-stache": "^3.0.1",
     "unescape-html": "^1.0.0"
   },
   "devDependencies": {
-    "bit-docs-generate-html": "^0.3.0",
+    "bit-docs-generate-html": "^0.5.0",
+    "bit-docs-generate-searchmap": "^0.0.1-0",
     "q": "^1.4.1",
     "connect": "^2.14.4",
     "normalize.css": "^4.1.1",

package.json

@@ -32,6 +32,14 @@ ul.title-links {
 .page-type{
 	h1{
 		display: inline-block;
+		float: left;
+	}
+	.title-social {
+		float: right;
+		margin-top: 15px;
+		li{
+			margin: 0 0 0 15px;
+		}
 	}
 	div{
 		display: inline-block;
@@ -50,8 +58,8 @@ ul.title-links {
 		  	display: block;
 		  	color: @link-color;
 		  	line-height: 1.7em;
-		  	cursor: pointer;
 		  	a:hover{
+		  		cursor: pointer;
 		  		text-decoration: underline;
 		  	}
 		}
@@ -65,3 +73,16 @@ ul.title-links {
 .description{
   	margin: @gutter 0;
 }
+
+/* Homepage hero images*/
+.hero-images {
+    border: 1px solid #EEE;
+    padding: 30px;
+	.tortoise {
+		float: right;
+		padding-right: 40px;
+	}
+	.hare {
+		padding-left: 40px;
+	}
+}

static/article-title.less

@@ -3,6 +3,7 @@ var LoadingBar = require('./loading-bar.js');
 $ = require("jquery");
 var debounce = require("lodash/debounce");
 var loader = new LoadingBar('blue');
+var SearchControl = require('./search');
 
 // state
 var $articleContainer,
@@ -12,22 +13,31 @@ var $articleContainer,
 	$everything,
 	$headers,
 	$nav,
+	$pathPrefix,
 	headerHidden,
 	animating,
 	navigating,
 	scrollPositionInterval,
-	currentHref;
+	currentHref,
+	searchControl,
+	hasShownSearch;
 
 (function() {
+	//flag that determines whether or not the search has already been shown
+	//(used for fading in or not)
+	hasShownSearch = false;
 	init();
 
 	// prevent sidebar from changing width when header hides
 	$('#left').css('min-width', $('.top-left').width());
 
 	// Override link behavior
 	$(document.body).on("click", "a", function(ev) {
-		var noModifierKeys = !ev.altKey && !ev.ctrlKey && !ev.metaKey && !ev.shiftKey;
-		if (noModifierKeys && this.hostname === window.location.hostname) {
+		var noModifierKeys = !ev.altKey && !ev.ctrlKey && !ev.metaKey && !ev.shiftKey,
+				sameHostname = this.hostname === window.location.hostname,
+				sameProtocol = this.protocol === window.location.protocol;
+
+		if (noModifierKeys && sameHostname && sameProtocol) {
 			ev.preventDefault();
 			var href = this.href;
 			window.history.pushState(null, null, href);
@@ -69,13 +79,35 @@ function init() {
 	$everything = $('#everything');
 	$headers = getHeaders();
 	$nav = $('.top-left > .brand, .top-right-top');
+	$pathPrefix = $("[path-prefix]").first();
 	headerHidden = undefined;
 	currentHref = window.location.href;
 
+	setPathPrefix();
 	setOnThisPageContent();
 	buildTOC();
 	setNavToggleListener();
 	setScrollPosition();
+	searchControl = new SearchControl(".search-bar", {
+		navigate: function(href){
+			window.history.pushState(null, null, href);
+			navigate(href);
+		},
+		pathPrefix: window.pathPrefix,
+		animateInOnStart: !hasShownSearch
+	});
+
+	hasShownSearch = true;
+}
+
+function setPathPrefix(){
+	var pathPrefix;
+	if($pathPrefix && $pathPrefix.length){
+		pathPrefix = $pathPrefix.attr("path-prefix");
+		if(pathPrefix && pathPrefix.length){
+			window.pathPrefix = pathPrefix;
+		}
+	}
 }
 
 function setDocTitle() {
@@ -163,14 +195,27 @@ function navigate(href) {
 			if (!$content.length) {
 				window.location.reload();
 			}
-			var $nav = $content.find(".bottom-left > ul");
-			var $article = $content.find("article");
-			var $breadcrumb = $content.find(".breadcrumb");
-			var homeLink = $content.find(".logo > a").attr('href');
-			$(".bottom-left>ul").replaceWith($nav);
+			var $nav = $content.find(".bottom-left > ul"),
+					$article = $content.find("article"),
+					$breadcrumb = $content.find(".breadcrumb"),
+					homeLink = $content.find(".logo > a").attr('href'),
+					$navReplace = $(".bottom-left>ul"),
+
+					//root elements - use .filter; not .find
+					$pathPrefixDiv = $content.filter("[path-prefix]");
+
+
+			//if any page doesn't have a nav, replacing it won't work,
+			//and the nav will be gone for any subsequent page visits
+			if($navReplace && $navReplace.length){
+				$navReplace.replaceWith($nav);
+			}else{
+				$(".bottom-left").append($nav);
+			}
 			$("article").replaceWith($article);
 			$(".breadcrumb").replaceWith($breadcrumb);
 			$(".logo > a").attr('href', homeLink);
+			$("[path-prefix]").replaceWith($pathPrefixDiv);
 
 			// Initialize jsbin scripts
 			delete window.jsbinified;

static/canjs.js

@@ -20,3 +20,4 @@
 @import "breadcrumb.less";
 @import "screenshots.less";
 @import "loading-bar.less";
+@import "search.less";

static/canjs.less

@@ -6,10 +6,6 @@
     justify-content: space-between;
 }
 
-.top-left {
-    display: none;
-}
-
 .brand {
     height: 53px;
     padding-top: @gutter;
@@ -41,10 +37,6 @@
 
 // ----- CANJS LOGO AND VERSION DESKTOP -----
 @media screen and (min-width: @breakpoint) {
-    .top-left {
-        display: block;
-    }
-
     .brand {
         .dropdown {
             position: absolute;
@@ -132,16 +124,7 @@
             font-size: 14px;
             margin-right: @gutter;
             > a {
-                font-weight: 700;
-                font-size: 12px;
-                padding: 2px 10px;
-                line-height: 20px;
-                .border-radius;
-                .border;
-                &:hover {
-                    text-decoration: none;
-                    background: @border-color;
-                }
+                .button-link
             }
         }
     }