Make the frames view the default. (Fixes #30)

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Master
 
+- [#30](https://github.com/netzpirat/codo/issues/30):  Make the frames view the default. ([@netzpirat][])
 - [#35](https://github.com/netzpirat/codo/issues/35):  Links aren't working on Class/Module List dropdown for parent nodes. ([@netzpirat][])
 - [#15](https://github.com/netzpirat/codo/issues/15): Generate a TOC for file contents. ([@netzpirat][])
 - Detect inner (nested) classes. ([@netzpirat][])

src/generator.coffee

@@ -25,48 +25,24 @@ module.exports = class Generator
   #
   #
   generate: ->
-    @generateFrames()
-    @generateReadme()
+    @generateIndex()
+
     @generateClasses()
     @generateModules()
-    @generateExtras()
-    @generateIndex()
-    @generateLists()
+    @generateFiles()
+
+    @generateClassAndModuleIndex()
+
+    @generateClassAndModuleLists()
     @generateMethodList()
     @generateFileList()
+
     @copyAssets()
 
   # Generate the frame source.
   #
-  generateFrames: ->
-    @templater.render 'frames', { path: '' }, 'frames.html'
-
-  # Generate the home page. This is the readme
-  #
-  generateReadme: ->
-    try
-      readme   = fs.readFileSync @options.readme, 'utf-8'
-      readme   = marked readme if /\.(markdown|md)$/.test @options.readme
-      filename = 'index.html'
-
-      @templater.render 'file', {
-        path: ''
-        filename: @options.readme,
-        content: readme
-        breadcrumbs: [
-          {
-            href: 'class_index.html'
-            name: 'Index'
-          }
-          {
-            href: "File: #{ filename }"
-            name: @options.readme
-          }
-        ]
-      }, filename
-
-    catch error
-      console.log "[ERROR] Cannot generate readme file #{ @options.readme }: #{ error }"
+  generateIndex: ->
+    @templater.render 'frames', { index: @options.readme, path: '' }, 'index.html'
 
   # Generates the pages for all the classes.
   #
@@ -140,7 +116,7 @@ module.exports = class Generator
 
   # Generates the pages for all the extra files.
   #
-  generateExtras: ->
+  generateFiles: ->
     for extra in _.union [@options.readme], @options.extras
       try
         content = fs.readFileSync extra, 'utf-8'
@@ -166,9 +142,9 @@ module.exports = class Generator
       catch error
         console.log "[ERROR] Cannot generate extra file #{ extra }: #{ error }"
 
-  # Generate the alphabetical index
+  # Generate the alphabetical index of all classes and modules.
   #
-  generateIndex: ->
+  generateClassAndModuleIndex: ->
     sortedClasses = {}
 
     # Sort in character group
@@ -190,7 +166,7 @@ module.exports = class Generator
 
   # Generates the drop down class list
   #
-  generateLists: ->
+  generateClassAndModuleLists: ->
     classes = []
     modules = []
 

theme/default/lib/styles/base.css

@@ -1,6 +1,6 @@
 /* line 1, ../../src/styles/base.scss */
 body {
-  padding: 0 20px;
+  padding: 0 5px;
   font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
   font-size: 13px;
 }

theme/default/src/styles/base.scss

@@ -1,5 +1,5 @@
 body {
-  padding: 0 20px;
+  padding: 0 5px;
   font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
   font-size: 13px;
 }

theme/default/templates/frames.hamlc

@@ -3,4 +3,4 @@
   != @JST['partials/head'](@)
   %frameset{ cols: '20%, *' }
     %frame{ name: 'list', src: 'class_list.html' }
-    %frame{ name: 'main', src: 'index.html' }
+    %frame{ name: 'main', src: "#{ @index }.html" }

theme/default/templates/partials/header.hamlc

@@ -12,10 +12,6 @@
 
     %nav
       %ul
-        %li.frames
-          != surround '(', ')', =>
-            %a.frames{ href: "#{ @path }frames.html" }> frames
-
         %li.noframes
           != surround '(', ')', ->
             %a.noframes{ href: '#' }> no frames