up-port style fixes

Author: tmcw

default-theme/README.md

@@ -1,30 +1,15 @@
-# documentation-theme-default
-
-[![Circle CI](https://circleci.com/gh/documentationjs/documentation-theme-default.svg?style=svg)](https://circleci.com/gh/documentationjs/documentation-theme-default)
+# the default theme
 
 ![](screenshot.png)
 
 This is the default theme for [documentationjs](https://github.com/documentationjs):
-it consists of Handlebars templates and a few assets: a [highlight.js](https://highlightjs.org/)
+it consists of underscore templates and a few assets: a [highlight.js](https://highlightjs.org/)
 theme and [basscss](http://www.basscss.com/) as a basic CSS framework.
 
 This is bundled by default in documentation: it is the default theme.
 
 The contents are the following:
 
-* `index.hbs`, the main template that defines the document structure
-* `section.hbs`, a partial used to render each chunk of documentation
+* `index._`, the main template that defines the document structure
+* `section._`, a partial used to render each chunk of documentation
 * `assets/*`, any assets, including CSS & JS
-
-# Helpers
-
-* `{{format_params}}`: format function parameters, including the types
-  included within.
-* `{{permalink}}`: in the context of a documentation chunk,
-  return the chunk's permalink
-* `{{autolink TEXT}}`: given a chunk of text that may be a reference to a
-  method, property, or other namespaced item, link the text to the item
-* `{{md TEXT}}`: render Markdown-formatted text, parsing additional
-  JSDoc inline tag syntax and linking links when necessary
-* `{{format_type}}`: format a type definition, like `{string}` within a
-  param definition.

default-theme/assets/style.css

@@ -85,7 +85,7 @@ h4:hover .anchorjs-link {
   }
 }
 
-.pre, pre, code {
+.pre, pre, code, .code {
   font-family: Source Code Pro,Menlo,Consolas,Liberation Mono,monospace;
   font-size: 14px;
 }
@@ -118,3 +118,26 @@ ul {
   border-radius: 3px;
   box-sizing: border-box;
 }
+
+table {
+  border-collapse: collapse;
+}
+
+.prose table th,
+.prose table td {
+  padding:8px;
+  border:1px solid #ddd;
+}
+
+.prose table {
+  border:1px solid #ddd;
+}
+
+.prose-big {
+  font-size: 18px;
+  line-height: 30px;
+}
+
+.quiet {
+  opacity: 0.7;
+}

default-theme/circle.yml

@@ -80,7 +80,11 @@
         <div class='px2'>
           <% docs.forEach(function(s) { %>
             <% if (s.kind !== 'note') { %>
-              <div class='keyline-top-not py2'><%=renderSection({ section: s, renderSection: renderSection })%></div>
+              <%= renderSection({
+                section: s,
+                renderSection: renderSection,
+                renderSectionList: renderSectionList
+              }) %>
             <% } else { %>
               <div class='keyline-top-not py2'><%=renderNote({ note: s })%></div>
             <% } %>

default-theme/index._

@@ -18,25 +18,47 @@ module.exports = function (comments, options, callback) {
   });
 
   var imports = {
-    signature: function (section) {
+    shortSignature: function (section, hasSectionName) {
+      var prefix = '';
+      if (section.kind === 'class') {
+        prefix = 'new ';
+      }
+      if (section.kind !== 'function' && !hasSectionName) {
+        return '';
+      }
+      if (hasSectionName) {
+        return prefix + section.name + formatParameters(section, true);
+      } else if (!hasSectionName && formatParameters(section)) {
+        return formatParameters(section, true);
+      }
+      return '()';
+    },
+    signature: function (section, hasSectionName) {
       var returns = '';
       var prefix = '';
       if (section.kind === 'class') {
         prefix = 'new ';
+      } else if (section.kind !== 'function') {
+        return section.name;
       }
       if (section.returns) {
         returns = ': ' +
           formatMarkdown.type(section.returns[0].type, namespaces);
       }
-      return prefix + section.name +
-        formatParameters(section) + returns;
+      if (hasSectionName) {
+        return prefix + section.name +
+          formatParameters(section) + returns;
+      } else if (!hasSectionName && formatParameters(section)) {
+        return section.name + formatParameters(section) + returns;
+      }
+      return section.name + '()' + returns;
     },
     md: function (ast, inline) {
       if (inline && ast && ast.children.length && ast.children[0].type === 'paragraph') {
-        return formatMarkdown({
+        ast = {
           type: 'root',
-          children: ast.children[0].children
-        }, namespaces);
+          children: ast.children[0].children.concat(ast.children.slice(1))
+        };
       }
       return formatMarkdown(ast, namespaces);
     },
@@ -59,6 +81,9 @@ module.exports = function (comments, options, callback) {
       renderNote: _.template(fs.readFileSync(path.join(__dirname, 'note._'), 'utf8'), {
         imports: imports
       }),
+      renderSectionList: _.template(fs.readFileSync(path.join(__dirname, 'section_list._'), 'utf8'), {
+        imports: imports
+      }),
       highlight: function (str) {
         return highlight(str);
       }

default-theme/index.js

@@ -1,5 +1,7 @@
 'use strict';
+
 var formatMarkdown = require('./format_markdown');
+var Syntax = require('doctrine').Syntax;
 
 /**
  * Format a parameter name. This is used in formatParameters
@@ -9,8 +11,12 @@ var formatMarkdown = require('./format_markdown');
  * @param {Object} param a param as a type spec
  * @returns {string} formatted parameter representation.
  */
-function formatParameter(param) {
-  return param.name + ': ' + formatMarkdown.type(param.type).replace(/\n/g, '');
+function formatParameter(param, short) {
+  if (short) {
+    return param.type.type == Syntax.OptionalType ? '[' + param.name + ']' : param.name;
+  } else {
+    return param.name + ': ' + formatMarkdown.type(param.type).replace(/\n/g, '');
+  }
 }
 
 /**
@@ -21,12 +27,12 @@ function formatParameter(param) {
  * @param {Object} section  comment node from documentation
  * @returns {string} formatted parameters
  */
-module.exports = function formatParams(section) {
+module.exports = function formatParams(section, short) {
   if (section.params) {
     return '(' + section.params.map(function (param) {
-      return formatParameter(param);
+      return formatParameter(param, short);
     }).join(', ') + ')';
-  } else if (!section.params && (section.type === 'function' || section.type === 'class')) {
+  } else if (!section.params && (section.kind === 'function' || section.kind === 'class')) {
     return '()';
   }
   return '';