Merge pull request #25 from Kovah/renew-docs

Renew of the documentation Pt.2
greggman · Nov 18, 2016 · 8d07d0b · 8d07d0b
2 parents e2be955 + 6c35f3c
commit 8d07d0b
Show file tree

Hide file tree

Showing 52 changed files with 2,333 additions and 4,262 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,10 @@ public/games
 public/examples
 docs/hft
 docs/relayserver
+docs/**/*.html
+!docs/**/toc.html
+!docs/unity/install.html
+!docs/unity/samples.html
 images/src
 .DS_Store
 *~

diff --git a/Gruntfile.js b/Gruntfile.js
@@ -33,6 +33,45 @@ module.exports = function(grunt) {
         'docs/dotnet',
       ],
     },
+    sass: {
+      docs: {
+        options: {
+          sourceMap: true,
+          outputStyle: 'compressed',
+        },
+        files: [{
+          expand: true,
+          cwd: 'docs/assets/scss',
+          dest: 'docs/assets/css',
+          src: ['**/*.scss'],
+          ext: '.css',
+        }]
+      },
+    },
+    uglify: {
+      docs_js: {
+        files: {
+          'docs/assets/3rdparty/jquery.js': ['node_modules/jquery/dist/jquery.min.js'],
+          'docs/assets/3rdparty/require.js': ['node_modules/requirejs/require.js'],
+        },
+      },
+    },
+    watch: {
+      docs_sass: {
+        files: ['docs/assets/scss/**/*.scss'],
+        tasks: ['sass:docs'],
+        options: {
+          spawn: false,
+        },
+      },
+      docs_md: {
+        files: ['docs/**/*.md', 'docs/**/toc.html'],
+        tasks: ['builddocs'],
+        options: {
+          spawn: false,
+        },
+      },
+    },
     eslint: {
         target: [
           'cli',
@@ -51,10 +90,14 @@ module.exports = function(grunt) {
   });
 
   grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-concat');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-watch');
   grunt.loadNpmTasks('grunt-jsdoc');
   grunt.loadNpmTasks('grunt-eslint');
+  grunt.loadNpmTasks('grunt-sass');
 
-  // WIP!!!
+  // Docs
   grunt.registerTask('unitydocsgen', function() {
     var done = this.async();
     var foo = require('./dev/js/dotnetdocs');
@@ -71,6 +114,16 @@ module.exports = function(grunt) {
         {
           filespec: "docs/*.md",
         },
+        {
+          filespec: "docs/making-games/*.md",
+          mainURL: "/docs/making-games",
+          toc: "docs/making-games/toc.html",
+        },
+        {
+          filespec: "docs/setup/*.md",
+          mainURL: "/docs/setup",
+          toc: "docs/setup/toc.html",
+        },
         {
           filespec: "docs/unity/*.md",
           mainURL: "/docs/unity",
@@ -92,6 +145,24 @@ module.exports = function(grunt) {
     });
   });
 
+  grunt.registerTask('docsassets', [
+    'sass:docs',
+    'uglify:docs_js',
+  ]);
+
+  grunt.registerTask('docsdev', [
+    'clean:docs',
+    'builddocs',
+    'docsassets',
+    'watch',
+  ]);
+
+  grunt.registerTask('docsbuild', [
+    'clean:docs',
+    'builddocs',
+    'docsassets',
+  ]);
+
   grunt.registerTask('default', ['eslint', 'clean:docs', 'jsdoc']);
 };
 
diff --git a/dev/templates/index.template b/dev/templates/index.template
@@ -53,9 +53,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 <title>{{title}}</title>
 
 <link href="/public/hft-icon.png" rel="shortcut icon" type="image/png">
-<link rel="stylesheet" href="/docs/css/base.css" type="text/css" />
-<link rel="stylesheet" href="/docs/css/lesson.css" type="text/css" />
-<link rel="stylesheet" href="/docs/css/index.css" type="text/css" />
+<link rel="stylesheet" href="/docs/assets/css/styles.css" type="text/css" />
 </head>
 <body>
 {{{include "dev/templates/header.template"}}}

diff --git a/dev/templates/lesson.template b/dev/templates/lesson.template
@@ -51,53 +51,53 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 <title>{{title}}</title>
 <link href="/public/hft-icon.png" rel="shortcut icon" type="image/png">
-<link rel="stylesheet" href="/docs/css/base.css" type="text/css" />
-<link rel="stylesheet" href="/docs/css/lesson.css" type="text/css" />
+<link rel="stylesheet" href="/docs/assets/css/styles.css" type="text/css" />
 </head>
 <body>
 {{{include "dev/templates/header.template"}}}
 <div class="container">
-  <div class="lesson-title">
+  <div class="docs-title">
     <h1>{{title}}</h1>
   </div>
   <div class="row">
-    <div class="col-sm-8 lesson-main">
+    <div class="col-sm-8 docs-content">
       {{{content}}}
-      <hr/>
-      <div>
+      <div class="docs-footer">
         <div>Questions? <a href="http://stackoverflow.com/questions/tagged/{{bs.stackoverflowTag}}">Ask on stackoverflow</a>.</div>
         <div>Issue/Bug? <a href="{{bs.bugIssueURL}}">Create an issue on github</a>.</div>
-
-        <div id="disqus_thread"></div>
-        <script type="text/javascript">
+        <div class="docs-comments">
+          <div id="disqus_thread"></div>
+          <script type="text/javascript">
             /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
             var disqus_shortname = '{{bs.disqusShortName}}'; // required: replace example with your forum shortname
             var disqus_identifier = '{{title}}';
             var disqus_title = '{{title}}';
 
             /* * * DON'T EDIT BELOW THIS LINE * * */
             (function() {
-                if (window.location.hostname.indexOf("{{bs.disqusCheckStr}}") < 0) {
-                    return;
-                }
-                var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-                dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
-                (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+              if (window.location.hostname.indexOf("{{bs.disqusCheckStr}}") < 0) {
+                return;
+              }
+              var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+              dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+              (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
             })();
-        </script>
-        <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
-        <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
+          </script>
+          <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+          <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
+        </div>
       </div>
     </div>
-    <div class="col-sm-3 col-sm-offset-1 lesson-sidebar">
+    <div class="col-sm-3 col-sm-offset-1 docs-sidebar">
         {{{include bs.toc}}}
     </div>
   </div>
 </div>
 </body>
-<script src="/docs/3rdparty/jquery-1.11.2.min.js"></script>
-<script src="/docs/3rdparty/prettify.js"></script>
-<script src="/docs/js/lesson.js"></script>
+<script src="/docs/assets/3rdparty/jquery.js"></script>
+<script src="/docs/assets/js/lesson.js"></script>
+<script src="/docs/assets/3rdparty/highlight.js"></script>
+<script>hljs.initHighlightingOnLoad();</script>
 {{{include "dev/templates/analytics.template" }}}
 </html>
 

diff --git a/docs/3rdparty/jquery-1.11.2.min.js b/docs/3rdparty/jquery-1.11.2.min.js