- Change landing page

Author: DannyBen

Gemfile

@@ -1,23 +1,17 @@
 source 'https://rubygems.org'
 
-# gem 'jekyll'
-
-# This gem is for local GitHub pages development, but it conflicts with
-# CmomonMarker (it requires a lower version than we need)
-# gem 'github-pages', group: :jekyll_plugins
-
 gem 'byebug'
+gem 'filewatcher-cli'
 gem 'lp'
+gem 'pretty_trace'
 gem 'rack-test'
-gem 'rdoc'
-gem 'rentacop'
 gem 'rspec'
-gem 'rspec_approvals'
 gem 'rspec-html-matchers'
+gem 'rspec_approvals'
 gem 'runfile'
 gem 'runfile-tasks'
 gem 'sasstool'
 gem 'simplecov'
-gem 'yard'
+gem 'slim'
 
 gemspec

README.md

@@ -1,3 +1,5 @@
+![Madness Logo](assets/header.png)
+
 # Madness - Instant Markdown Server
 
 [![Gem Version](https://badge.fury.io/rb/madness.svg)](https://badge.fury.io/rb/madness)
@@ -6,34 +8,15 @@
 
 ---
 
-## Screenshots (click to zoom)
-
-<table><tr>
-  <td><a target='_screenshot' href='assets/screen-main.png'><img src='assets/screen-main.png'/></a></td>
-  <td><a target='_screenshot' href='assets/screen-nav.png'><img src='assets/screen-nav.png'/></a></td>
-  <td><a target='_screenshot' href='assets/screen-code.png'><img src='assets/screen-code.png'/></a></td>
-  <td><a target='_screenshot' href='assets/screen-search.png'><img src='assets/screen-search.png'/></a></td>
-</tr></table>
-
-## Table of Contents
-
-* [Install](#install)
-* [Design Intentions](#design-intentions)
-* [Feature Highlights](#feature-highlights)
-* [Usage](#usage)
-* [Directory Conventions](#directory-conventions)
-* [Configuration File](#configuration-file)
-* [Search](#search)
-* [Images and Static Files](#images-and-static-files)
-* [Automatic H1](#automatic-h1)
-* [Shortlinks](#shortlinks)
-* [Table of Contents Generation](#table-of-contents-generation)
-* [Hidden Directories](#hidden-directories)
-* [Controlling Sort Order](#controlling-sort-order)
-* [Displaying Additional File Types](#displaying-additional-file-types)
-* [Basic Authentication](#basic-authentication)
-* [Customizing Theme](#customizing-theme)
-* [Docker Image](#docker-image)
+Madness is a command line server for rendering markdown documents in your
+browser. It is designed to facilitate easy development of internal
+markdown-based documentation site.
+
+<!-- MADNESS_TOC -->
+
+## Screenshots
+
+[![Screenshots](assets/screenshots.gif)](assets/screenshots.gif)
 
 ## Install
 
@@ -56,11 +39,6 @@ $ brew gem install madness
 $ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness'
 ```
 
-## Design Intentions
-
-Madness was designed in order to provide easy browsing, viewing and 
-searching for local, markdown based documentation directories.
-
 ## Feature Highlights
 
 - Easy to use.
@@ -69,9 +47,13 @@ searching for local, markdown based documentation directories.
 - Configure with a configuration file or command arguments.
 - Fully customizable theme.
 - Automatic generation of navigation sidebar.
-- Automatic generation of Table of Contents (site-wide and inline).
-- Can optionally show additional file types in the navigation menu (e.g. PDF files).
+- Automatic generation of Table of Contents (site-wide and per page).
+- Can optionally show additional file types in the navigation menu (e.g. PDF
+  files).
 - Optional support for `[[Short Link]]` syntax.
+- Optional basic authentication.
+- Support for extended markdown syntax, such as footnotes and syntax
+  highlighting.
 
 ## Usage
 
@@ -93,14 +75,14 @@ $ madness --help
 
 Madness expects to be executed in a documentation directory.
 
-A documentation directory contains only markdown files (`*.md`) and 
-sub directories that contain more markdown files.
+A documentation directory contains only markdown files (`*.md`) and sub
+directories that contain more markdown files.
 
-The server will consider the file `index.md` or `README.md` in any directory 
-as the main file describing this directory, where `index.md` has priority.
+The server will consider the file `index.md` or `README.md` in any directory as
+the main file describing this directory, where `index.md` has priority.
 
-The navigation sidebar will show all the sub directories and files in 
-the same directory as the viewed file.
+The navigation sidebar will show all the sub directories and files in the same
+directory as the viewed file.
 
 Example structure:
 
@@ -119,9 +101,17 @@ Example structure:
 
 ## Configuration File
 
-All the command line arguments can also be configured through a 
-configuration file. Create a file named `.madness.yml` in your 
-documentation directory, and modify any of the settings below.
+Madness uses sensible defaults, so therefore can be executed without configuring
+anything. Configuration is mostly done by having a file named `.madness.yml` in
+your documentation directory.
+
+For convenience, you can generate a template config file by running:
+
+```shell
+$ madness create config
+```
+
+which will generate this file, with all the default options:
 
 ```yaml
 # .madness.yml
@@ -144,12 +134,14 @@ auto_h1: true
 # append navigation to directory READMEs
 auto_nav: true
 
+# replace <!-- TOC --> in any file with its internal table of contents
+# set to true to enable it with the default '## Table of Contents' caption,
+# or set to any string that will be inserted before it as a caption.
+auto_toc: true
+
 # enable syntax highlighter for code snippets
 highlighter: true
 
-# enable line numbers for code snippets
-line_numbers: true
-
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 
@@ -183,12 +175,6 @@ expose_extensions: ~
 exclude: ['^[a-z_\-0-9]+$']
 ```
 
-For convenience, you can generate a template config file by running:
-
-```shell
-$ madness create config
-```
-
 ## Search
 
 Madness comes with a full text search page.
@@ -235,13 +221,18 @@ file or a directory in the same directory as the file itself.
 To generate a Table of Contents file for the entire site (for the directories
 and files), run `madness --toc FILENAME`
 
-### Inline
+### In-page
 
 If you have long markdown documents, and you wish to add an inline Table of
 Contents for them, simply add an HTML comment `<!-- TOC -->` where you want
 the Table of Contents to be generated. The inserted list will only consider
 H2 and H3 headings.
 
+Note that for this feature to work, your markdown document must use the #-based
+heading syntax.
+
+The 'Table of Contents' heading can be customized in the configuration file.
+
 ## Hidden Directories
 
 Directories that are made only of lowercase letters, underscoes, dash and/or

Runfile

@@ -1,5 +1,7 @@
 require_relative 'lib/madness'
 require "sasstool"
+require "slim"
+require "pretty_trace/enable-trim"
 require "runfile-tasks"
 
 title   "Madness Runfile"
@@ -8,18 +10,18 @@ version Madness::VERSION
 
 RunfileTasks::RubyGems.all 'madness'
 RunfileTasks::Testing.rspec
-RunfileTasks::Docs.rdoc
 
 help   "Generate public CSS"
-action :css do
-  target = "app/public/css"
-  Sasstool::Renderer.new("app/styles/main.scss").save target
-  puts "Saved #{target}"
-end
-
-help   "Run YARD server"
-action :yard do
-  system "yard server -p3000 -B0.0.0.0 -r"
+usage  'css [--watch]'
+option '-w, --watch', 'Watch for changes and regenerate'
+action :css do |args|
+  if args['--watch']
+    exec "filewatcher --immediate 'app/styles/*.scss' 'bundle exec run css'"
+  else
+    target = "app/public/css"
+    Sasstool::Renderer.new("app/styles/main.scss").save target
+    puts "Saved #{target}"
+  end
 end
 
 usage  "(server|s) [--sample]"
@@ -30,21 +32,16 @@ action :server, :s do |args|
   system "bundle exec bin/madness #{folder}"
 end
 
-help   "Run IRB console"
-action :console, :c do
-  system "bundle exec bin/console"
-end
-
-help   "Generate TOC to toc.txt"
-action :toc do
-  exec 'gh-md-toc README.md > toc.txt'
-end
+help   'Extract fontello zip'
+action :fontello do
+  system 'mkdir -p tmp/fontello'
+  zip = 'assets/fontello.zip'
+  system "unzip -j -o  #{zip} -d tmp/fontello"
+  %w[eot svg ttf woff woff2].each do |ext|
+    system "cp tmp/fontello/fontello.#{ext} app/public/font/"
+  end
 
-help   "Generate usage.md"
-action :usage do
-  content = "# Madness Usage\n\n```shell\n$ madness --help\n\n#{`bundle exec madness --help`}\n```\n"
-  File.write 'usage.md', content
-  puts "Created usage.md"
+  system 'cp tmp/fontello/fontello.css app/styles/_fontello.scss'
 end
 
 help   "Generate changelog and append old changelog"
@@ -59,10 +56,35 @@ action :cloc do
   system "cloc . --exclude-dir coverage,spec,examples"
 end
 
-help   "Run a local Jekyll deployment for GitHub Pages tests"
-usage  "jekyll"
-action :jekyll do |args|
-  exec "jekyll serve -H 0.0.0.0 -P 3000"
+help   "Generate the screenshots animated gif"
+action :screenshots do
+  puts "Saving assets/screenshots.gif"
+  exec "convert -delay 300 -loop 0 assets/screenshots/*.png assets/screenshots.gif"
+end
+
+help   "Generate the site to /docs"
+action :site do
+  # Use the README as a base, and do some TOC acrobatics to prevent the HTML
+  # generator from converting some TOC comments.
+  readme = File.read('README.md')
+    .gsub('<!-- TOC -->', '{{TOC_COMMENT}}')
+    .gsub('<!-- MADNESS_TOC -->', '<!-- TOC -->')
+    .sub(/\[!\[Gem Version\].*/, '')
+    .sub(/\[!\[Build Status\].*/, '')
+    .sub(/\[!\[Maintainability\].*/, '')
+
+  # Create the Madness page using Madness
+  content = Madness::MarkdownDocument.new(readme)
+    .to_html
+    .gsub '{{TOC_COMMENT}}', '&lt;!-- TOC --&gt;'
+
+  # Place the rendered HTML inside a slim template
+  Slim::Engine.set_options pretty: true    
+  html = Slim::Template.new("assets/site/index.slim").render(nil, content: content)
+  
+  # Export for GitHub pages
+  File.write 'docs/index.html', html
+  puts 'Saved docs/index.html'
 end
 
 require_relative 'debug.rb' if File.exist? 'debug.rb'

_config.yml

@@ -0,0 +1,2 @@
+This folder contains several support files for the GitHub repository and
+for other development needs.