Breadcrumb, attribution blocks. How deps. are loaded.

renoirb · renoirb · commit b587984b786f · 2015-11-02T12:32:49.000-05:00
diff --git a/.bowerrc b/.bowerrc
@@ -0,0 +1,4 @@
+{
+  "analytics": false,
+  "directory": "static/bower_components"
+}
diff --git a/Makefile b/Makefile
@@ -3,7 +3,7 @@ PATH := bin:${PATH}
 DATE := `date '+%Y%m%d'`
 
 
-build: src/ node_modules/ static/assets/css/highlight.css
+build: src/ node_modules/ static/bower_components/ static/assets/css/highlight.css
 		time npm run build
 
 
@@ -15,16 +15,18 @@ src:
 			cd ..;\
 		fi
 
+static/bower_components/: node_modules/
+		node_modules/.bin/bower install
 
-static/assets/css/highlight.css: node_modules/
+static/assets/css/highlight.css: node_modules
 		cp node_modules/highlight.js/styles/solarized_dark.css static/assets/css/highlight.css
 
 
-node_modules: package.json
+node_modules/: package.json
 		npm install
 
 
-rsync:
+rsync: build
 		rsync -az --delete --progress --exclude=".git" build/ upstream-docs1.staging.wpdn:/srv/webapps/docs/build/
 		rsync -az config/nginx/ upstream-docs1.staging.wpdn:/etc/nginx/docs/
 
diff --git a/bower.json b/bower.json
@@ -0,0 +1,20 @@
+{
+  "name": "generator-docs",
+  "version": "2.0.0",
+  "description": "WebPlatform Docs Static site generatora static site generator.",
+  "homepage": "https://github.com/webplatform/generator-docs#readme",
+  "license": "CC-BY-3.0",
+  "authors": [
+    "Renoir Boulanger <renoir@w3.org>"
+  ],
+  "ignore": [
+    "build",
+    "node_modules",
+    "bower_components"
+  ],
+  "dependencies": {
+    "jquery": "~1.11",
+    "vue": "~0.12",
+    "ie7-js": "*"
+  }
+}
diff --git a/layouts/default.hbs b/layouts/default.hbs
@@ -7,15 +7,16 @@
     <link rel="stylesheet" href="/assets/css/highlight.css" />
     <link rel="shortcut icon" href="/favicon.ico" />
     <meta name="viewport" content="width=device-width" />
-    <!--[if lt IE 7]><script src="//www.webplatform.org/assets/bower_components/ie7-js/lib/IE7.js"></script><![endif]-->
-    <!--[if lt IE 8]><script src="//www.webplatform.org/assets/bower_components/ie7-js/lib/IE8.js"></script><![endif]-->
-    <!--[if lt IE 9]><script src="//www.webplatform.org/assets/bower_components/ie7-js/lib/IE9.js"></script><![endif]-->
-    <!--[if lt IE 9]><script src="//docs.webplatform.org/w/extensions/WebPlatformDocs/skin/html5shiv.js"></script><![endif]-->
+    <!--[if lt IE 7]><script src="/bower_components/ie7-js/lib/IE7.js"></script><![endif]-->
+    <!--[if lt IE 8]><script src="/bower_components/ie7-js/lib/IE8.js"></script><![endif]-->
+    <!--[if lt IE 9]><script src="/bower_components/ie7-js/lib/IE9.js"></script><![endif]-->
     <!--[if lt IE 8]><link rel="stylesheet" href="//www.webplatform.org/assets/css/ie7.css"><![endif]-->
     {{>metadata}}
-
+    <script src="/bower_components/jquery/dist/jquery.min.js"></script>
+    <script src="/bower_components/vue/dist/vue.min.js"></script>
   </head>
   <body class="mediawiki ltr sitedir-ltr skin-webplatform action-view">
+    {{#readiness_marker}}{{readiness}}{{/readiness_marker}}
     <header id="mw-head" class="noprint">
       <div class="container">
         <div id="p-logo">
@@ -49,25 +50,34 @@
         <a id="top"></a>
         <div class="tool-area">
               <div id="hierarchy-menu">
-                <ol id="breadcrumb-info" class="breadcrumbs">
-                  <li><a href="/">DOCS</a></li>
-                </ol>
+                  {{>breadcrumb}}
               </div>
               <div class="toolbar">
+                {{#if uri}}
+                {{! If we do not have an uri front matter, we might }}
+                {{! not want edit buttons. Notice that we gotta }}
+                {{! make sure the content pages always has an uri }}
+                {{! front-matter. }}
                 <div><a class="highlighted edit button" text="Edit" href="https://github.com/webplatform/docs/blob/master">Edit</a></div>
                 <div class="dropdown"><a class="tools button">Tools</a>
                     <ul>
-                        <li><a href="?action=history" rel="archives">History</a></li>
+                        <li><a data-pivot-trigger="history" href="?action=history" rel="archives">History</a></li>
                     </ul>
                 </div>
+                {{/if}}
             </div>
         </div>
         <div id="page">
           <div id="page-content">
             <div id="main-content">
               <h1>{{title}}</h1>
+              <section class="contents-pivot" data-pivot="contents">
 {{{ contents }}}
 {{>attributions}}
+              </section>
+              <section class="contents-pivot pivot-history" data-pivot="history" style="display:none" id="history">
+
+              </section>
             </div>
             <div class="topics-nav">
               <ul>
@@ -99,7 +109,6 @@
         </ul -->
       </div>
     </footer>
-    <script src="/assets/js/dependencies.js" async defer></script>
-    <script src="/assets/js/docs.js" async defer></script>
+    <script src="/assets/js/docs.js"></script>
   </body>
 </html>
diff --git a/lib/handlebars/index.js b/lib/handlebars/index.js
@@ -10,9 +10,32 @@ module.exports = function () {
   'use strict';
    var md = new Remarkable();
 
-Handlebars.registerHelper('markdown', function(options) {
-	var text = md.render(options.fn(this));
-  return new Handlebars.SafeString( text );
+Handlebars.registerHelper('markdown', function markdownRendererHelper (options) {
+  var text = md.render(options.fn(this));
+  return new Handlebars.SafeString(text);
+});
+
+Handlebars.registerHelper('breadcrumbize', function breadcrumbizeHelper (options) {
+  var fragments = options.fn(this).split('/')
+    , subpath = '/'
+    , out = '';
+
+  fragments.forEach(function(str, index, full){
+    subpath += str + '/';
+    out += '<li><a href="' + subpath + '">' + str + '</a></li>';
+  });
+
+  return new Handlebars.SafeString(out);
+});
+
+Handlebars.registerHelper('readiness_marker', function readinessHelper (options) {
+    var  label = options.fn(this)
+      ,  className = label.replace(/\s/g, '_')
+      ,  template = '<div class="readiness-state ' + className + '"><p>This page is <a>' + label + '</a></p></div>';
+
+    if ( label !== null ) {
+      return new Handlebars.SafeString(template);
+    }
 });
 
 };
diff --git a/package.json b/package.json
@@ -22,7 +22,9 @@
     "serve": "node serve",
     "build": "node build"
   },
-  "dependencies": {
+  "devDependencies": {
+    "bower": "*",
+    "express": "^4.13.3",
     "handlebars": "^2.0",
     "remarkable": "^1.6.0",
     "highlight.js": "^8.8.0",
@@ -31,8 +33,5 @@
     "metalsmith-changed": "~0.2",
     "metalsmith-layouts": "~1.4",
     "metalsmith-markdown-remarkable": "^0.1.1"
-  },
-  "devDependencies": {
-    "express": "^4.13.3"
   }
 }
diff --git a/partials/attributions.hbs b/partials/attributions.hbs
@@ -1,6 +1,10 @@
+{{#if attributions}}
 <h2>Attributions</h2>
 <ul>
 {{#attributions}}
 	<li>{{#markdown}}{{.}}{{/markdown}}</li>
 {{/attributions}}
-</ul>
+</ul>
+{{else}}
+<!-- Attributions: None declared for this document. -->
+{{/if}}
diff --git a/partials/breadcrumb.hbs b/partials/breadcrumb.hbs
@@ -0,0 +1,6 @@
+<ol id="breadcrumb-info" class="breadcrumbs">
+  <li><a href="/">DOCS</a></li>
+{{#if uri}}
+	{{#breadcrumbize}}{{uri}}{{/breadcrumbize}}
+{{/if}}
+</ol>
diff --git a/partials/metadata.hbs b/partials/metadata.hbs
@@ -1,6 +1,3 @@
 {{#readiness}}<meta name="readiness" content="{{.}}" />{{/readiness}}
 {{#standardization_status}}<meta name="standardization" content="{{.}}" />{{/standardization_status}}
 {{#summary}}<meta name="description" content="{{.}}" />{{/summary}}
-{{#each attributions}}
-<meta name="attribution" content="{{.}}" />
-{{/each}}
diff --git a/static/assets/js/dependencies.js b/static/assets/js/dependencies.js
diff --git a/static/assets/js/docs.js b/static/assets/js/docs.js

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "analytics": false,
 +  "directory": "static/bower_components"
 +}