Update

Updated to reflect changes in Doxx.
mr-doc · Sep 13, 2015 · 0d1a4d0 · 0d1a4d0
1 parent fd9bb8b
commit 0d1a4d0
Show file tree

Hide file tree

Showing 10 changed files with 397 additions and 31 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,4 +30,5 @@ node_modules
 bower_components/
 
 # Sass cache
-.sass-cache
+.sass-cache
+*.tgz
diff --git a/gulpfile.js b/gulpfile.js
@@ -54,7 +54,7 @@ var template = cmd.template + join(cwd, 'template/index.jade');
 
 // Task 1: Build the docs
 gulp.task('docs',shell.task([
-    'npm start && ./node_modules/doxx/bin/doxx ' + source + target + template
+    './node_modules/doxx/bin/doxx ' + source + target + template
 ]));
 
 // Task 2: Build Sass and copy it into the test dir and assets

diff --git a/package.json b/package.json
@@ -4,12 +4,12 @@
   "version": "1.0.0",
   "homepage": "http://github.com/iwatakeshi/doxx-theme-cayman",
   "author": "iwatakeshi",
-  "scripts":{
-    "start":"npm i && bower i"
+  "scripts": {
+    "start": "npm i && bower i"
   },
   "devDependencies": {
     "browser-sync": "^2.9.1",
-    "doxx": "file:doxx-2.0.0.tgz",
+    "doxx": "git+https://[email protected]/iwatakeshi/doxx.git",
     "gulp": "^3.9.0",
     "gulp-clipboard": "^0.1.1",
     "gulp-connect": "^2.2.0",

diff --git a/template/index.jade b/template/index.jade
@@ -12,9 +12,12 @@ html(lang='en-us')
     meta(name='viewport', content='width=device-width, initial-scale=1')
     link(rel='stylesheet', href='https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css')
     link(rel='stylesheet', href='https://fonts.googleapis.com/css?family=Open+Sans:400,700', type='text/css')
-    link(rel='stylesheet', href='css/bootstrap.css')
-    link(rel='stylesheet', href='css/cayman.css')
-    link(rel='stylesheet', href='css/prism.css')
+    each file in files
+      each target in targets
+        if file.name === target.name
+          link(rel='stylesheet', href=target.relative.path + 'css/bootstrap.css')
+          link(rel='stylesheet', href=target.relative.path + 'css/cayman.css')
+          link(rel='stylesheet', href=target.relative.path + 'css/prism.css')
   body
     section.page-header
       h1.project-name= project.title
@@ -26,24 +29,27 @@ html(lang='en-us')
       if(project.url.homepage)
         a.btn(href=project.url.homepage target='_blank')
     section(data-spy='scroll' data-target='.scrollspy').main-content
+      span #{console.log(targets)}
       .row
         .col-md-3.bs-docs-sidebar
           ul.nav.nav-stacked.fixed#sidebar
             each file in files
-              li(class=(file.name !== currentName ? "":"active"))
-                a(href=file.relName) #{file.name}
-                  if file.name === currentName
-                      ul.nav.nav-stacked
-                        each symbol in symbols
-                          li
-                            if name === currentName
-                              a(href='#'+symbol.name)
-                                mixin iForSymbolType(symbol)
-                                span #{symbol.name}
-                            else
-                              a(href=symbol.targetFile+'#'+symbol.name)
-                                mixin iForSymbolType(symbol)
-                                span #{symbol.name}
+              each target in targets
+                if file.name === target.name
+                  li(class=(file.name !== currentName ? "":"active"))
+                    a(href=target.relative.path + file.relName) #{file.name}
+                      if file.name === currentName
+                          ul.nav.nav-stacked
+                            each symbol in symbols
+                              li
+                                if name === currentName
+                                  a(href='#'+symbol.name)
+                                    mixin iForSymbolType(symbol)
+                                    span #{symbol.name}
+                                else
+                                  a(href=symbol.targetFile+'#'+symbol.name)
+                                    mixin iForSymbolType(symbol)
+                                    span #{symbol.name}
 
         .col-md-9
           if locals.readme
@@ -114,13 +120,16 @@ html(lang='en-us')
               |  by 
               a(href='https://twitter.com/jasonlong') Jason Long
               | .
-    script(src='js/jquery.min.js')
-    script(src='js/bootstrap.min.js')
-    script(src='js/affix.js')
-    script(src='js/dropdown.js')
-    script(src='js/scrollspy.js')
-    script(src='js/prism.js')
-    script(src='js/prism-bash.js')
+    each file in files
+      each target in targets
+        if file.name === target.name
+          script(src=target.relative.path + 'js/jquery.min.js')
+          script(src=target.relative.path + 'js/bootstrap.min.js')
+          script(src=target.relative.path + 'js/affix.js')
+          script(src=target.relative.path + 'js/dropdown.js')
+          script(src=target.relative.path + 'js/scrollspy.js')
+          script(src=target.relative.path + 'js/prism.js')
+          script(src=target.relative.path + 'js/prism-bash.js')
     script.
       $(document).ready(function(){
         $('body').scrollspy({

diff --git a/test/docs/api/api.js.html b/test/docs/api/api.js.html
@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <head>
+    <meta charset="UTF-8">
+    <title>doxx-theme-cayman</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css">
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700" type="text/css">
+    <link rel="stylesheet" href="../css/bootstrap.css">
+    <link rel="stylesheet" href="../css/cayman.css">
+    <link rel="stylesheet" href="../css/prism.css">
+    <link rel="stylesheet" href="../css/bootstrap.css">
+    <link rel="stylesheet" href="../css/cayman.css">
+    <link rel="stylesheet" href="../css/prism.css">
+    <link rel="stylesheet" href="../css/bootstrap.css">
+    <link rel="stylesheet" href="../css/cayman.css">
+    <link rel="stylesheet" href="../css/prism.css">
+    <link rel="stylesheet" href="../css/bootstrap.css">
+    <link rel="stylesheet" href="../css/cayman.css">
+    <link rel="stylesheet" href="../css/prism.css">
+  </head>
+  <body>
+    <section class="page-header">
+      <h1 class="project-name">doxx-theme-cayman</h1>
+      <h2 class="project-tagline">A responsive theme for your Doxx generated documentations.</h2><a href="http://github.com/iwatakeshi/doxx-theme-cayman" target="_blank" class="btn">View on GitHub</a>
+    </section>
+    <section data-spy="scroll" data-target=".scrollspy" class="main-content"><span></span>
+      <div class="row">
+        <div class="col-md-3 bs-docs-sidebar">
+          <ul id="sidebar" class="nav nav-stacked fixed">
+            <li><a href="../index.html">Main</a></li>
+            <li class="active"><a href="../api/api.js.html">api/api.js
+                <ul class="nav nav-stacked">
+                  <li><a href="#Doxx"><i class="alert alert-success"></i><span>Doxx</span></a>
+                  </li>
+                  <li><a href="#generate"><i class="alert alert-info"></i><span>generate</span></a>
+                  </li>
+                  <li><a href="#fn"><i class="alert alert-info"></i><span>fn</span></a>
+                  </li>
+                </ul></a></li>
+            <li><a href="../api/api2/api.js.html">api/api2/api.js</a></li>
+            <li><a href="../index.js.html">index.js</a></li>
+          </ul>
+        </div>
+        <div class="col-md-9">
+          <section id="Doxx">
+            <h1>Doxx</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-success radius ctx-type">class</div><span>&nbsp;</span><span>new Doxx()</span><span>&nbsp;</span><span>&nbsp;</span><span class="label label-default">extends</span><span>&nbsp;</span><span>Compiler</span>
+            </p>
+          </section>
+          <div class="description"></div>
+          <pre><code class="language-javascript">class Doxx extends Compiler {
+	constructor(){
+
+	}</code></pre>
+          <section id="generate">
+            <h1>generate</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-info radius ctx-type">method</div><span>&nbsp;</span><span>Doxx.prototype.generate()</span><span>&nbsp;</span>
+            </p>
+          </section>
+          <div class="description"><p>Generates the files</p></div>
+          <pre><code class="language-javascript">generate (){
+
+}</code></pre>
+          <section id="fn">
+            <h1>fn</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-info radius ctx-type">method</div><span>&nbsp;</span><span>Doxx.prototype.fn()</span><span>&nbsp;</span>
+            </p>
+          </section>
+          <div class="description"><p>Some other function</p></div>
+          <pre><code class="language-javascript">fn () {
+
+}
+}</code></pre>
+          <div class="footer site-footer">
+            <div class="span site-footer-owner"><a href="https://github.com/iwatakeshi/doxx-theme-cayman">Cayman</a> is maintained by <a href="https://github.com/iwatakeshi">iwatakeshi</a>.</div>
+            <div class="span site-footer-credits">This page was generated by <a href="https://github.com/FGRibreau/doxx">Doxx</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</div>
+          </div>
+        </div>
+      </div>
+    </section>
+    <script src="../js/jquery.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+    <script src="../js/affix.js"></script>
+    <script src="../js/dropdown.js"></script>
+    <script src="../js/scrollspy.js"></script>
+    <script src="../js/prism.js"></script>
+    <script src="../js/prism-bash.js"></script>
+    <script src="../js/jquery.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+    <script src="../js/affix.js"></script>
+    <script src="../js/dropdown.js"></script>
+    <script src="../js/scrollspy.js"></script>
+    <script src="../js/prism.js"></script>
+    <script src="../js/prism-bash.js"></script>
+    <script src="../js/jquery.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+    <script src="../js/affix.js"></script>
+    <script src="../js/dropdown.js"></script>
+    <script src="../js/scrollspy.js"></script>
+    <script src="../js/prism.js"></script>
+    <script src="../js/prism-bash.js"></script>
+    <script src="../js/jquery.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+    <script src="../js/affix.js"></script>
+    <script src="../js/dropdown.js"></script>
+    <script src="../js/scrollspy.js"></script>
+    <script src="../js/prism.js"></script>
+    <script src="../js/prism-bash.js"></script>
+    <script>
+      $(document).ready(function(){
+        $('body').scrollspy({
+          target: ".bs-docs-sidebar",
+          offset: 40
+        }) 
+      });
+    </script>
+  </body>
+</html>
diff --git a/test/docs/api/api2/api.js.html b/test/docs/api/api2/api.js.html
@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <head>
+    <meta charset="UTF-8">
+    <title>doxx-theme-cayman</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css">
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700" type="text/css">
+    <link rel="stylesheet" href="../../css/bootstrap.css">
+    <link rel="stylesheet" href="../../css/cayman.css">
+    <link rel="stylesheet" href="../../css/prism.css">
+    <link rel="stylesheet" href="../../css/bootstrap.css">
+    <link rel="stylesheet" href="../../css/cayman.css">
+    <link rel="stylesheet" href="../../css/prism.css">
+    <link rel="stylesheet" href="../../css/bootstrap.css">
+    <link rel="stylesheet" href="../../css/cayman.css">
+    <link rel="stylesheet" href="../../css/prism.css">
+    <link rel="stylesheet" href="../../css/bootstrap.css">
+    <link rel="stylesheet" href="../../css/cayman.css">
+    <link rel="stylesheet" href="../../css/prism.css">
+  </head>
+  <body>
+    <section class="page-header">
+      <h1 class="project-name">doxx-theme-cayman</h1>
+      <h2 class="project-tagline">A responsive theme for your Doxx generated documentations.</h2><a href="http://github.com/iwatakeshi/doxx-theme-cayman" target="_blank" class="btn">View on GitHub</a>
+    </section>
+    <section data-spy="scroll" data-target=".scrollspy" class="main-content"><span></span>
+      <div class="row">
+        <div class="col-md-3 bs-docs-sidebar">
+          <ul id="sidebar" class="nav nav-stacked fixed">
+            <li><a href="../../index.html">Main</a></li>
+            <li><a href="../../api/api.js.html">api/api.js</a></li>
+            <li class="active"><a href="../../api/api2/api.js.html">api/api2/api.js
+                <ul class="nav nav-stacked">
+                  <li><a href="#Doxx"><i class="alert alert-success"></i><span>Doxx</span></a>
+                  </li>
+                  <li><a href="#generate"><i class="alert alert-info"></i><span>generate</span></a>
+                  </li>
+                  <li><a href="#fn"><i class="alert alert-info"></i><span>fn</span></a>
+                  </li>
+                </ul></a></li>
+            <li><a href="../../index.js.html">index.js</a></li>
+          </ul>
+        </div>
+        <div class="col-md-9">
+          <section id="Doxx">
+            <h1>Doxx</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-success radius ctx-type">class</div><span>&nbsp;</span><span>new Doxx()</span><span>&nbsp;</span><span>&nbsp;</span><span class="label label-default">extends</span><span>&nbsp;</span><span>Compiler</span>
+            </p>
+          </section>
+          <div class="description"></div>
+          <pre><code class="language-javascript">class Doxx extends Compiler {
+	constructor(){
+
+	}</code></pre>
+          <section id="generate">
+            <h1>generate</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-info radius ctx-type">method</div><span>&nbsp;</span><span>Doxx.prototype.generate()</span><span>&nbsp;</span>
+            </p>
+          </section>
+          <div class="description"><p>Generates the files</p></div>
+          <pre><code class="language-javascript">generate (){
+
+}</code></pre>
+          <section id="fn">
+            <h1>fn</h1>
+            <h5 class="subheader"></h5>
+            <p>
+              <div class="label label-info radius ctx-type">method</div><span>&nbsp;</span><span>Doxx.prototype.fn()</span><span>&nbsp;</span>
+            </p>
+          </section>
+          <div class="description"><p>Some other function</p></div>
+          <pre><code class="language-javascript">fn () {
+
+}
+}</code></pre>
+          <div class="footer site-footer">
+            <div class="span site-footer-owner"><a href="https://github.com/iwatakeshi/doxx-theme-cayman">Cayman</a> is maintained by <a href="https://github.com/iwatakeshi">iwatakeshi</a>.</div>
+            <div class="span site-footer-credits">This page was generated by <a href="https://github.com/FGRibreau/doxx">Doxx</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</div>
+          </div>
+        </div>
+      </div>
+    </section>
+    <script src="../../js/jquery.min.js"></script>
+    <script src="../../js/bootstrap.min.js"></script>
+    <script src="../../js/affix.js"></script>
+    <script src="../../js/dropdown.js"></script>
+    <script src="../../js/scrollspy.js"></script>
+    <script src="../../js/prism.js"></script>
+    <script src="../../js/prism-bash.js"></script>
+    <script src="../../js/jquery.min.js"></script>
+    <script src="../../js/bootstrap.min.js"></script>
+    <script src="../../js/affix.js"></script>
+    <script src="../../js/dropdown.js"></script>
+    <script src="../../js/scrollspy.js"></script>
+    <script src="../../js/prism.js"></script>
+    <script src="../../js/prism-bash.js"></script>
+    <script src="../../js/jquery.min.js"></script>
+    <script src="../../js/bootstrap.min.js"></script>
+    <script src="../../js/affix.js"></script>
+    <script src="../../js/dropdown.js"></script>
+    <script src="../../js/scrollspy.js"></script>
+    <script src="../../js/prism.js"></script>
+    <script src="../../js/prism-bash.js"></script>
+    <script src="../../js/jquery.min.js"></script>
+    <script src="../../js/bootstrap.min.js"></script>
+    <script src="../../js/affix.js"></script>
+    <script src="../../js/dropdown.js"></script>
+    <script src="../../js/scrollspy.js"></script>
+    <script src="../../js/prism.js"></script>
+    <script src="../../js/prism-bash.js"></script>
+    <script>
+      $(document).ready(function(){
+        $('body').scrollspy({
+          target: ".bs-docs-sidebar",
+          offset: 40
+        }) 
+      });
+    </script>
+  </body>
+</html>