优化jsdoc模板 缩小文档大小

Author: songyumeng

build/jsdocs/template/publish.js

@@ -107,7 +107,26 @@ function getPathFromDoclet(doclet) {
 
     return filepath;
 }
+function generateNav(nav) {
+
+    // var docData = {
+    //     filename: "",
+    //     title: title,
+    //     docs: docs,
+    //     packageInfo: ( find({kind: 'package'}) || [] ) [0]
+    // };
+    var docData = {
+        filename: "nav.html",
+        title: "",
+        nav: nav,
+    };
+    var outpath = path.join(outdir, "nav.html"),
+        html = view.partial('navigation.tmpl', docData);
+
+        html = helper.resolveLinks(html); // turn {@link foo} into <a href="foodoc.html">foo</a>
 
+    fs.writeFileSync(outpath, html, 'utf8');
+}
 function generate(title, docs, filename, resolveLinks) {
     resolveLinks = resolveLinks === false ? false : true;
 
@@ -428,6 +447,7 @@ exports.publish = function(taffyData, opts, tutorials) {
 
     // once for all
     view.nav = buildNav(members);
+    generateNav(view.nav);
     attachModuleSymbols( find({ kind: ['class', 'function'], longname: {left: 'module:'} }),
         members.modules );
 

build/jsdocs/template/static/scripts/main.js

@@ -1,57 +1,56 @@
 $(function () {
-    // Search Items
-    $('#searchBox').on('keyup', function (e) {
-        var value = $(this).val();
-        var $el = $('.navigation');
-
-        if (value) {
-            var regexp = new RegExp(value, 'i');
-            $el.find('li, .itemMembers').hide();
-
-            $el.find('li').each(function (i, v) {
-                var $item = $(v);
-
-                if ($item.data('name') && regexp.test($item.data('name'))) {
-                    $item.show();
-                    $item.closest('.itemMembers').show();
-                    $item.closest('.item').show();
-                }
-            });
-        } else {
-            $el.find('.item, .itemMembers').show();
-        }
-
-        $el.find('.list').scrollTop(0);
-    });
-
-    // Toggle when click an item element
-    $('.navigation').on('click', '.title', function (e) {
-        $(this).parent().find('.itemMembers').toggle();
-    });
-
-    // Show an item related a current documentation automatically
-    var filename = $('.page-title').data('filename').replace(/\.[a-z]+$/, '');
-    var $currentItem = $('.navigation .item[data-name*="' + filename + '"]:eq(0)');
-
-    if ($currentItem.length) {
-        $currentItem
-            .remove()
-            .prependTo('.navigation .list')
-            .show()
-            .find('.itemMembers')
+    $('.navigationDiv').load("nav.html .navigation",null,function(){
+        // Search Items
+        $('#searchBox').on('keyup', function (e) {
+            var value = $(this).val();
+            var $el = $('.navigation');
+
+            if (value) {
+                var regexp = new RegExp(value, 'i');
+                $el.find('li, .itemMembers').hide();
+
+                $el.find('li').each(function (i, v) {
+                    var $item = $(v);
+
+                    if ($item.data('name') && regexp.test($item.data('name'))) {
+                        $item.show();
+                        $item.closest('.itemMembers').show();
+                        $item.closest('.item').show();
+                    }
+                });
+            } else {
+                $el.find('.item, .itemMembers').show();
+            }
+
+            $el.find('.list').scrollTop(0);
+        });
+
+        // Toggle when click an item element
+        $('.navigation').on('click', '.title', function (e) {
+            $(this).parent().find('.itemMembers').toggle();
+        });
+        // Show an item related a current documentation automatically
+        var filename = $('.page-title').data('filename').replace(/\.[a-z]+$/, '');
+        var $currentItem = $('.navigation .item[data-name*="' + filename + '"]:eq(0)');
+
+        if ($currentItem.length) {
+            $currentItem
+                .remove()
+                .prependTo('.navigation .list')
+                .show()
+                .find('.itemMembers')
                 .show();
-    }
-
-    // Auto resizing on navigation
-    var _onResize = function () {
-        var height = $(window).height();
-        var $el = $('.navigation');
-
-        $el.height(height).find('.list').height(height - 120);
-    };
+        }
 
-    $(window).on('resize', _onResize);
-    _onResize();
+        // Auto resizing on navigation
+        var _onResize = function () {
+            var height = $(window).height();
+            var $el = $('.navigation');
 
+            $el.height(height).find('.list').height(height - 120);
+        };
 
+        $(window).on('resize', _onResize);
+        _onResize();
+    });
 });

build/jsdocs/template/tmpl/layout.tmpl

@@ -14,7 +14,9 @@
 </head>
 <body>
 <div id="wrap" class="clearfix">
-    <?js= this.partial('navigation.tmpl', this) ?>
+
+    <div class="navigationDiv">
+    </div>
     <div class="main">
         <h1 class="page-title" data-filename="<?js= filename ?>"><?js= title ?></h1>
         <?js= content ?>