Skip to content

Commit

Permalink
Executable docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Jul 7, 2010
1 parent 900c5ed commit 21eeb09
Show file tree
Hide file tree
Showing 5 changed files with 204 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
*.csv
*.dat
*.out
.pomo
benchmarks/graphs
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

DOCS = docs/index.md \
docs/executable.md \
docs/migrate.md

MANPAGES =$(DOCS:.md=.1)
Expand Down
24 changes: 24 additions & 0 deletions docs/executable.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.\" generated with Ronn/v0.6.6
.\" http://github.com/rtomayko/ronn/
.
.TH "EXECUTABLE" "" "July 2010" "" ""
.
.SH "Synopsis"
.
.nf

express [\-h|\-\-help] [PATH]
.
.fi
.
.SH "Description"
The \fBexpress\fR executable generates apps at the given \fBPATH\fR or the current working directory\. Although Express is not bound to a specific application structure, this executable creates a maintainable base app\.
.
.SH "Options"
.
.nf

\-h, \-\-help Display help information
.
.fi

174 changes: 174 additions & 0 deletions docs/executable.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<html>
<head>
<title>Express - node web framework</title>
<style>
#header {
position: fixed;
top: 10px;
left: 0;
padding: 12px 40px;
width: 100%;
border-top: 1px solid rgba(0,0,0,0.7);
border-bottom: 1px solid rgba(0,0,0,0.7);
background: rgba(255,255,255,0.1) url(http://www.sencha.com/favicon.ico) no-repeat 15px 50%;
text-align: left;
color: #fff;
}
#tagline {
margin-left: 75px;
margin-bottom: 30px;
color: rgba(255,255,255,0.7); }
html {
background: #1c1c1c url(images/bg.tile.jpg); }

body {
margin: 0;
padding-bottom: 30px;
font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
font-size: 14px;
line-height: 1.5;
-webkit-text-stroke: 1px rgba(0, 0, 0, 0.1);
-moz-text-stroke: 1px rgba(0, 0, 0, 0.1);
background: url(images/bg.jpg) 50% 0 no-repeat;
color: #8b8b8b; }

* {
outline: none; }

em {
color: white; }

a img {
border: none !important; }

a {
font-weight: bold;
color: white;
-webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-webkit-transition-duration: 0.15s;
-webkit-transition-timing-function: ease-out; }
a:hover {
opacity: 0.8; }

h1, h2, h3 {
margin: 45px 0 0 0;
color: white;
text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }

h3 {
margin-left: 20px;
font-size: 18px; }

pre {
margin: 20px 10px;
padding: 25px 20px;
background: rgba(0,0,0,0.5);
border: 1px solid #323232;
-webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-webkit-border-radius: 5px;
-moz-border-radius: 5px; }

code {
font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }

ul {
margin: 15px 0;
padding: 0 0 0 35px; }
ul li {
margin: 0;
padding: 2px 0;
list-style: square; }

.sect {
margin-left: 40px; }

#logo {
display: block;
margin-left: 30%;
margin-bottom: 30px;
width: 194px;
height: 51px;
background: url(images/logo.png) 0 0 no-repeat;
text-indent: -99999px; }
#logo:hover {
opacity: 0.7; }
#logo:active {
opacity: 0.3; }

#ribbon {
position: fixed;
top: 0;
right: 0;
z-index: 2; }

#wrapper {
width: 100%;
min-height: 800px;
background: url(images/top.png) 0 0 repeat-x; }

#container {
margin: 0 auto;
padding-top: 110px;
width: 550px; }

#menu {
margin-left: 100px;
padding: 0;
padding-bottom: 30px; }
#menu li {
display: inline;
list-style: none; }
#menu li a {
display: block;
float: left;
margin: 0 2px;
padding: 3px 15px;
background: rgba(0,0,0,0.2);
-webkit-border-radius: 8px;
-moz-border-radius: 8px;
-webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-webkit-transition-duration: 0.15s;
-webkit-transition-timing-function: ease-out; }
#menu li a:hover,
#menu li a.active {
padding: 3px 20px;
background: rgba(0,0,0,0.5); }
#menu li a:active {
background: rgba(0,0,0,0.1);
-webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
</style>
</head>
<body>
<a href='http://github.com/visionmedia/express'>
<img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' />
</a>
<div id="header"><strong>Sencha</strong> labs</div>
<div id="wrapper">
<div id="container">
<a href='http://github.com/visionmedia/express' id='logo'>Express</a>
<div class='mp'>
<h2 id="Synopsis">Synopsis</h2>

<pre><code>express [-h|--help] [PATH]
</code></pre>

<h2 id="Description">Description</h2>

<p>The <code>express</code> executable generates apps at the given <strong>PATH</strong> or the
current working directory. Although Express is not bound to a specific
application structure, this executable creates a maintainable base app.</p>

<h2 id="Options">Options</h2>

<pre><code>-h, --help Display help information
</code></pre>

</div>
</div>
</div>
</body>
</html>
8 changes: 4 additions & 4 deletions docs/executable.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
express(1) -- node web framework
========================================

## Synopsis

express [-h|--help] [PATH]

## Description

Express is a high performance Sinatra-inspired web framework.
The `express` executable generates apps at the given **PATH** or the
current working directory. Although Express is not bound to a specific
application structure, this executable creates a maintainable base app.

## Executable Options
## Options

-h, --help Display help information

0 comments on commit 21eeb09

Please sign in to comment.