mirrors/EWF
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use Jekyll (#27)

Browse Source
This commit is contained in:
Olivier Ligot
2013-08-23 10:45:38 +02:00
parent 4761743995
commit a64f5bbe6f
7 changed files with 98 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -1 +1,2 @@
*.swp *.swp
_gh_pages

18
README.md Normal file
View File

@@ -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/).

15
_config.yml Normal file
View File

@@ -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

45
_layouts/default.html Normal file
View File

@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>
{% if page.title == "Eiffel Web Framework" %}
{{ page.title }}
{% else if %}
{{ page.title }} &middot; Eiffel Web Framework
{% endif %}
</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="{{ page.base_url }}css/vendor/bootstrap.min.css" rel="stylesheet">
<link href="{{ page.base_url }}css/main.css" rel="stylesheet">
<link href="{{ page.base_url }}css/vendor/lang-eiffel.css" rel="stylesheet">
</head>
<body>
<div class="container-narrow">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li{% if page.slug == "index" %} class="active"{% endif %}>
<a href="{{ page.base_url }}index.html">Home</a>
</li>
<li{% if page.slug == "getting-started" %} class="active"{% endif %}>
<a href="{{ page.base_url }}getting-started">Getting Started</a>
</li>
<li{% if page.slug == "community" %} class="active"{% endif %}>
<a href="{{ page.base_url }}community">Community</a>
</li>
</ul>
<h3 class="muted">Eiffel Web Framework</h3>
</div>
<hr>
{{ content }}
<hr>
<div class="footer">
<p>&copy; EiffelWebFramework 2013</p>
</div>
</div> <!-- /container -->
<script src="{{ page.base_url }}js/vendor/jquery.min.js"></script>
<script src="{{ page.base_url }}js/vendor/bootstrap.min.js"></script>
<script src="{{ page.base_url }}js/vendor/run_prettify.js"></script>
<script src="{{ page.base_url }}js/vendor/lang-eiffel.js"></script>
</body>
</html>

35
community.html
View File

@@ -1,23 +1,9 @@
<!DOCTYPE html> ---
<html> layout: default
<head> title: Community
<meta charset="utf-8"> slug: community
<title>Eiffel Web Framework</title> base_url: "../"
<meta name="viewport" content="width=device-width, initial-scale=1.0"> ---
<link href="css/vendor/bootstrap.min.css" rel="stylesheet">
<link href="css/main.css" rel="stylesheet">
</head>
<body>
<div class="container-narrow">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="index.html">Home</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li class="active"><a href="community.html">Community</a></li>
</ul>
<h3 class="muted">Eiffel Web Framework</h3>
</div>
<hr>
<div class="row"> <div class="row">
<div class="col-md-4"> <div class="col-md-4">
<h2>Development</h2> <h2>Development</h2>
@@ -40,12 +26,3 @@
</p> </p>
</div> </div>
</div> </div>
<hr>
<div class="footer">
<p>&copy; EiffelWebFramework 2013</p>
</div>
</div> <!-- /container -->
<script src="js/vendor/jquery.min.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
</body>
</html>

38
getting-started.html
View File

@@ -1,24 +1,9 @@
<!DOCTYPE html> ---
<html> layout: default
<head> title: Getting Started
<meta charset="utf-8"> slug: getting-started
<title>Eiffel Web Framework</title> base_url: "../"
<meta name="viewport" content="width=device-width, initial-scale=1.0"> ---
<link href="css/vendor/bootstrap.min.css" rel="stylesheet">
<link href="css/main.css" rel="stylesheet">
<link href="css/vendor/lang-eiffel.css" rel="stylesheet">
</head>
<body>
<div class="container-narrow">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="index.html">Home</a></li>
<li class="active"><a href="getting-started.html">Getting Started</a></li>
<li><a href="community.html">Community</a></li>
</ul>
<h3 class="muted">Eiffel Web Framework</h3>
</div>
<hr>
<div class="row"> <div class="row">
<div class="col-md-12"> <div class="col-md-12">
<div class="page-header"> <div class="page-header">
@@ -77,14 +62,3 @@ feature {NONE} -- Initialization
You should now see a simple page with <i>Hello World</i>.</p> You should now see a simple page with <i>Hello World</i>.</p>
</div> </div>
</div> </div>
<hr>
<div class="footer">
<p>&copy; EiffelWebFramework 2013</p>
</div>
</div> <!-- /container -->
<script src="js/vendor/jquery.min.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
<script src="js/vendor/run_prettify.js"></script>
<script src="js/vendor/lang-eiffel.js"></script>
</body>
</html>

37
index.html
View File

@@ -1,36 +1,13 @@
<!DOCTYPE html> ---
<html> layout: default
<head> title: Eiffel Web Framework
<meta charset="utf-8"> slug: index
<title>Eiffel Web Framework</title> base_url: "./"
<meta name="viewport" content="width=device-width, initial-scale=1.0"> ---
<link href="css/vendor/bootstrap.min.css" rel="stylesheet">
<link href="css/main.css" rel="stylesheet">
</head>
<body>
<div class="container-narrow">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li class="active"><a href="index.html">Home</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="community.html">Community</a></li>
</ul>
<h3 class="muted">Eiffel Web Framework</h3>
</div>
<hr>
<div class="jumbotron"> <div class="jumbotron">
<h1>Eiffel Web Framework</h1> <h1>Eiffel Web Framework</h1>
<p class="lead"> <p class="lead">
Framework to build web applications in Eiffel Framework to build web applications in Eiffel
</p> </p>
<a class="btn btn-default btn-lg btn-primary" href="https://github.com/EiffelWebFramework/EWF/archive/v0.3.1.zip">Download</a> <a class="btn btn-default btn-lg btn-primary" href="{{ site.download }}">Download</a>
</div> </div>
<hr>
<div class="footer">
<p>&copy; EiffelWebFramework 2013</p>
</div>
</div> <!-- /container -->
<script src="js/vendor/jquery.min.js"></script>
<script src="js/vendor/bootstrap.min.js"></script>
</body>
</html>