Create jekyll online help

author: Alban Peignier 2012-03-16 12:44:01 +0100
committer: Alban Peignier 2012-03-16 12:44:01 +0100
commit: 153c6f7022a608c6780b265d3b91c95829b192e4 (patch)
tree: 87f9c986dbb186aea7d6d9f2ccefa13a3a19d9e1
parent: 6792aa2c5f368a6147bf930391f0458e362e6160 (diff)
download: chouette-core-153c6f7022a608c6780b265d3b91c95829b192e4.tar.bz2
10 files changed, 171 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 38af9eb64..65620c008 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@
 /tmp
 *~
 public/assets/
+public/help/*
diff --git a/Gemfile b/Gemfile
index 8461ab5ab..f386fa013 100644
--- a/Gemfile
+++ b/Gemfile
@@ -61,6 +61,8 @@ group :development do
   gem 'capistrano-ext'   
   gem 'guard'
   gem 'guard-rspec'
+  gem 'jekyll'
+  gem 'RedCloth'
 end
 
 group :test, :development, :cucumber do
diff --git a/Gemfile.lock b/Gemfile.lock
index 13fa6df90..15b044599 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -57,6 +57,8 @@ GEM
   remote: http://rubygems.org/
   specs:
     GeoRuby (1.3.4)
+    RedCloth (4.2.9)
+    RedCloth (4.2.9-java)
     SyslogLogger (1.4.0)
       hoe (>= 1.2.0)
     ZenTest (4.5.0)
@@ -89,6 +91,8 @@ GEM
     activesupport (3.1.3)
       multi_json (~> 1.0)
     addressable (2.2.6)
+    albino (1.3.3)
+      posix-spawn (>= 0.3.6)
     arel (2.2.3)
     autotest-notification (2.3.4)
       autotest-standalone (~> 4.5)
@@ -114,6 +118,8 @@ GEM
       xpath (~> 0.1.4)
     childprocess (0.3.0)
       ffi (~> 1.0.6)
+    classifier (1.3.3)
+      fast-stemmer (>= 1.0.0)
     coffee-rails (3.1.1)
       coffee-script (>= 2.2.0)
       railties (~> 3.1.0)
@@ -135,6 +141,7 @@ GEM
       nokogiri (>= 1.5.0)
     database_cleaner (0.7.1)
     diff-lcs (1.1.3)
+    directory_watcher (1.4.1)
     erubis (2.7.0)
     execjs (1.2.13)
       multi_json (~> 1.0)
@@ -143,6 +150,7 @@ GEM
     factory_girl_rails (1.6.0)
       factory_girl (~> 2.5.0)
       railties (>= 3.0.0)
+    fast-stemmer (1.0.0)
     ffi (1.0.11)
     ffi (1.0.11-java)
     formtastic (2.0.2)
@@ -167,6 +175,13 @@ GEM
     inherited_resources (1.3.0)
       has_scope (~> 0.5.0)
       responders (~> 0.6.0)
+    jekyll (0.11.2)
+      albino (~> 1.3)
+      classifier (~> 1.3)
+      directory_watcher (~> 1.1)
+      kramdown (~> 0.13)
+      liquid (~> 2.3)
+      maruku (~> 0.5)
     jquery-rails (1.0.19)
       railties (~> 3.0)
       thor (~> 0.14)
@@ -176,16 +191,20 @@ GEM
     jruby-rack (1.1.2)
     json (1.6.5)
     json (1.6.5-java)
+    kramdown (0.13.5)
     launchy (2.0.5)
       addressable (~> 2.2.6)
     launchy (2.0.5-java)
       addressable (~> 2.2.6)
       ffi (~> 1.0.9)
       spoon (~> 0.0.1)
+    liquid (2.3.0)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
     mime-types (1.17.2)
     multi_json (1.0.4)
     net-scp (1.0.4)
@@ -201,6 +220,7 @@ GEM
     polyamorous (0.5.0)
       activerecord (~> 3.0)
     polyglot (0.3.3)
+    posix-spawn (0.3.6)
     rack (1.3.6)
     rack-cache (1.1)
       rack (>= 0.4)
@@ -279,6 +299,7 @@ GEM
       activerecord (~> 3.0)
       activesupport (~> 3.0)
       polyamorous (~> 0.5.0)
+    syntax (1.0.0)
     term-ansicolor (1.0.7)
     thor (0.14.6)
     tilt (1.3.3)
@@ -304,6 +325,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  RedCloth
   SyslogLogger
   activerecord-jdbcpostgresql-adapter!
   activerecord-jdbcsqlite3-adapter
@@ -325,6 +347,7 @@ DEPENDENCIES
   guard
   guard-rspec
   inherited_resources
+  jekyll
   jquery-rails
   jruby-openssl
   json
diff --git a/doc/functional/_config.yml b/doc/functional/_config.yml
new file mode 100644
index 000000000..fa1c30662
--- /dev/null
+++ b/doc/functional/_config.yml
@@ -0,0 +1,3 @@
+permalink: :month-:day-:year/:title.html
+
+
diff --git a/doc/functional/_layouts/default.html b/doc/functional/_layouts/default.html
new file mode 100644
index 000000000..ed13ca5f6
--- /dev/null
+++ b/doc/functional/_layouts/default.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <base href="/help/"/>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" />
+
+    <link href="/assets/application.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+    <link href="/assets/user_interface.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+    <link href="/assets/user_interface/layout.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+    <link href="/assets/formtastic.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+    <link href="/assets/formtastic_changes.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+    <link href="/assets/legacy.css?body=1" media="screen" rel="stylesheet" type="text/css" />
+
+    <link href="/help/stylesheets/help.css" media="screen" rel="stylesheet" type="text/css" /> 
+    <title>Chouette Documentation - {{ page.title }}</title>
+  </head>
+  <body>
+    <div id="header">
+      <div class="infos">
+        <ul class="user">
+          <li><a href="/">Accueil</a></li>
+        </ul>
+        <h1>Chouette Documentation</h1>
+      </div>
+      <div class="tabs">
+        <ul class="main">
+          <li><a class="current" href="/help/">Accueil</a></li>
+        </ul>
+      </div>
+    </div>
+
+    <div id="body">
+      <div id="workspace">
+        <h2>{{ page.title }}</h2>
+        {{ content }}
+      </div>
+    </div>
+  </body>
+</html>
+
diff --git a/doc/functional/_layouts/post.html b/doc/functional/_layouts/post.html
new file mode 100644
index 000000000..007adf923
--- /dev/null
+++ b/doc/functional/_layouts/post.html
@@ -0,0 +1,7 @@
+---
+layout: default
+---
+
+<h2>{{ page.title }}</h2>
+
+{{ content }}
diff --git a/doc/functional/index.textile b/doc/functional/index.textile
new file mode 100644
index 000000000..92c6e79d6
--- /dev/null
+++ b/doc/functional/index.textile
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Présentation
+---
+
+p. TODO
+
diff --git a/doc/functional/stylesheets/help.css b/doc/functional/stylesheets/help.css
new file mode 100644
index 000000000..437b28347
--- /dev/null
+++ b/doc/functional/stylesheets/help.css
@@ -0,0 +1,38 @@
+#workspace h2 {
+    font-size: 17px;
+}
+
+#workspace h3 {
+    font-size: 15px;
+}
+
+#workspace h4 {
+    font-weight: bold;
+    padding: 7px 0;
+}
+
+#workspace ul li {
+    list-style: circle;
+    margin: 7px 0 7px 20px;
+}
+
+#workspace em {
+    font-style: italic;
+}
+
+#workspace table {
+    width: 100%;
+}
+
+#workspace table td {
+    padding: 3px 5px;
+    width: 30%;
+}
+
+#workspace dt {
+    margin: 5px 0; 
+}
+
+#workspace dd {
+    padding-left: 10px;
+}
+\ No newline at end of file
diff --git a/doc/functional/stylesheets/help.scss b/doc/functional/stylesheets/help.scss
new file mode 100644
index 000000000..42a5a2d0c
--- /dev/null
+++ b/doc/functional/stylesheets/help.scss
@@ -0,0 +1,38 @@
+#workspace h2 {
+    font-size: 17px;
+}
+
+#workspace h3 {
+    font-size: 15px;
+}
+
+#workspace h4 {
+    font-weight: bold;
+    padding: 7px 0;
+}
+
+#workspace ul li {
+    list-style: circle;
+    margin: 7px 0 7px 20px;
+}
+
+#workspace em {
+    font-style: italic;
+}
+
+#workspace table {
+    width: 100%;
+}
+
+#workspace table td {
+    padding: 3px 5px;
+    width: 30%;
+}
+
+#workspace dt {
+    margin: 5px 0; 
+}
+
+#workspace dd {
+    padding-left: 10px;
+}
diff --git a/lib/tasks/jekyll.rake b/lib/tasks/jekyll.rake
new file mode 100644
index 000000000..5f7a06162
--- /dev/null
+++ b/lib/tasks/jekyll.rake
@@ -0,0 +1,11 @@
+namespace :jekyll do
+  desc "Generate help from doc/functional sources (use AUTO option to auto-regenerate)"
+  task :dist do
+    options = "--auto" if ENV['AUTO']
+    sh "jekyll #{options} doc/functional public/help"
+  end
+  desc "Clean generated help"
+  task :clean do
+    rm_rf "public/help"
+  end
+end
author	Alban Peignier	2012-03-16 12:44:01 +0100
committer	Alban Peignier	2012-03-16 12:44:01 +0100
commit	153c6f7022a608c6780b265d3b91c95829b192e4 (patch)
tree	87f9c986dbb186aea7d6d9f2ccefa13a3a19d9e1
parent	6792aa2c5f368a6147bf930391f0458e362e6160 (diff)
download	chouette-core-153c6f7022a608c6780b265d3b91c95829b192e4.tar.bz2