From a64f5bbe6fb6607d66f3578bbbdacab03c9618a2 Mon Sep 17 00:00:00 2001 From: Olivier Ligot Date: Fri, 23 Aug 2013 10:45:38 +0200 Subject: [PATCH] Use Jekyll (#27) --- .gitignore | 1 + README.md | 18 +++++++++++++++++ _config.yml | 15 +++++++++++++++ _layouts/default.html | 45 +++++++++++++++++++++++++++++++++++++++++++ community.html | 35 ++++++--------------------------- getting-started.html | 38 ++++++------------------------------ index.html | 37 +++++++---------------------------- 7 files changed, 98 insertions(+), 91 deletions(-) create mode 100644 README.md create mode 100644 _config.yml create mode 100644 _layouts/default.html diff --git a/.gitignore b/.gitignore index 1377554e..272b7a22 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.swp +_gh_pages diff --git a/README.md b/README.md new file mode 100644 index 00000000..3d9f1228 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Eiffel Web Framework + +Eiffel Web Framework is a framework to build web applications in Eiffel. + +To get started, check out [http://oligot.github.io/EWF/](http://oligot.github.io/EWF/)! + +## Documentation + +Eiffel Web Framework's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://oligot.github.io/EWF/](http://oligot.github.io/EWF/). The docs may also be run locally. + +### Running documentation locally + +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x). +2. From the root `/EWF` directory, run `jekyll serve` in the command line. + - **Windows users:** run `chcp 65001` first to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors. +3. Open [http://localhost:9000](http://localhost:9000) in your browser, and voilà. + +Learn more about using Jekyll by reading their [documentation](http://jekyllrb.com/docs/home/). diff --git a/_config.yml b/_config.yml new file mode 100644 index 00000000..01ef4517 --- /dev/null +++ b/_config.yml @@ -0,0 +1,15 @@ +# Dependencies +markdown: rdiscount +pygments: true + +# Permalinks +permalink: pretty + +# Server +destination: ./_gh_pages +exclude: [".gitignore", "Gruntfile.js", "package.json", "node_modules", "README.md"] +port: 9000 + +# Custom vars +repo: https://github.com/EiffelWebFramework/EWF +download: https://github.com/EiffelWebFramework/EWF/archive/v0.3.1.zip diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 00000000..adc759d8 --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,45 @@ + + + + + + {% if page.title == "Eiffel Web Framework" %} + {{ page.title }} + {% else if %} + {{ page.title }} · Eiffel Web Framework + {% endif %} + + + + + + + +
+
+ +

Eiffel Web Framework

+
+
+ {{ content }} +
+
+

© EiffelWebFramework 2013

+
+
+ + + + + + diff --git a/community.html b/community.html index 090128c8..1a0d7ffe 100644 --- a/community.html +++ b/community.html @@ -1,23 +1,9 @@ - - - - - Eiffel Web Framework - - - - - -
-
- -

Eiffel Web Framework

-
-
+--- +layout: default +title: Community +slug: community +base_url: "../" +---

Development

@@ -40,12 +26,3 @@

-
-
-

© EiffelWebFramework 2013

-
-
- - - - diff --git a/getting-started.html b/getting-started.html index 25add949..5f52d348 100644 --- a/getting-started.html +++ b/getting-started.html @@ -1,24 +1,9 @@ - - - - - Eiffel Web Framework - - - - - - -
-
- -

Eiffel Web Framework

-
-
+--- +layout: default +title: Getting Started +slug: getting-started +base_url: "../" +---
@@ -77,14 +62,3 @@ feature {NONE} -- Initialization You should now see a simple page with Hello World.

-
-
-

© EiffelWebFramework 2013

-
-
- - - - - - diff --git a/index.html b/index.html index 621faf9e..b77f8edf 100644 --- a/index.html +++ b/index.html @@ -1,36 +1,13 @@ - - - - - Eiffel Web Framework - - - - - -
-
- -

Eiffel Web Framework

-
-
+--- +layout: default +title: Eiffel Web Framework +slug: index +base_url: "./" +---

Eiffel Web Framework

Framework to build web applications in Eiffel

- Download + Download
-
-
-

© EiffelWebFramework 2013

-
-
- - - -