wpstudio/hiring-test-one
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Lloyd Brookes
2015-11-27 09:36:46 +00:00
parent 8bc0d87431
commit e794ed1a44
2 changed files with 24 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -35,32 +35,30 @@ $ ws --help
A simple web-server for productive front-end development. A simple web-server for productive front-end development.
Synopsis <strong>Synopsis</strong>
$ ws [<server options>] $ ws [\<server options\>]
$ ws --config $ ws --config
$ ws --help $ ws --help
Server <strong>Server</strong>
-p, --port number Web server port. -p, --port number Web server port.
-d, --directory path Root directory, defaults to the current directory. -d, --directory path Root directory, defaults to the current directory.
-f, --log-format string If a format is supplied an access log is written to -f, --log-format string If a format is supplied an access log is written to stdout. If
stdout. If not, a dynamic statistics view is displayed. not, a dynamic statistics view is displayed. Use a preset ('none',
Use a preset ('none', 'dev','combined', 'short', 'tiny' 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a
or 'logstalgia') or supply a custom format (e.g. custom format (e.g. ':method -> :url').
':method -> :url'). -r, --rewrite expression ... A list of URL rewrite rules. For each rule, separate the 'from'
-r, --rewrite expression ... A list of URL rewrite rules. For each rule, separate the and 'to' routes with '->'. Whitespace surrounded the routes is
'from' and 'to' routes with '->'. Whitespace surrounded ignored. E.g. '/from -> /to'.
the routes is ignored. E.g. '/from -> /to'.
-s, --spa file Path to a Single Page App, e.g. app.html. -s, --spa file Path to a Single Page App, e.g. app.html.
-c, --compress Serve gzip-compressed resources, where applicable. -c, --compress Serve gzip-compressed resources, where applicable.
-b, --forbid path ... A list of forbidden routes. -b, --forbid path ... A list of forbidden routes.
-n, --no-cache Disable etag-based caching -forces loading from disk -n, --no-cache Disable etag-based caching -forces loading from disk each request.
each request.
--verbose Verbose output, useful for debugging. --verbose Verbose output, useful for debugging.
Misc <strong>Misc</strong>
-h, --help Print these usage instructions. -h, --help Print these usage instructions.
--config Print the stored config. --config Print the stored config.

26
jsdoc2md/README.hbs
View File

@ -35,32 +35,30 @@ $ ws --help
A simple web-server for productive front-end development. A simple web-server for productive front-end development.
Synopsis <strong>Synopsis</strong>
$ ws [<server options>] $ ws [\<server options\>]
$ ws --config $ ws --config
$ ws --help $ ws --help
Server <strong>Server</strong>
-p, --port number Web server port. -p, --port number Web server port.
-d, --directory path Root directory, defaults to the current directory. -d, --directory path Root directory, defaults to the current directory.
-f, --log-format string If a format is supplied an access log is written to -f, --log-format string If a format is supplied an access log is written to stdout. If
stdout. If not, a dynamic statistics view is displayed. not, a dynamic statistics view is displayed. Use a preset ('none',
Use a preset ('none', 'dev','combined', 'short', 'tiny' 'dev','combined', 'short', 'tiny' or 'logstalgia') or supply a
or 'logstalgia') or supply a custom format (e.g. custom format (e.g. ':method -> :url').
':method -> :url'). -r, --rewrite expression ... A list of URL rewrite rules. For each rule, separate the 'from'
-r, --rewrite expression ... A list of URL rewrite rules. For each rule, separate the and 'to' routes with '->'. Whitespace surrounded the routes is
'from' and 'to' routes with '->'. Whitespace surrounded ignored. E.g. '/from -> /to'.
the routes is ignored. E.g. '/from -> /to'.
-s, --spa file Path to a Single Page App, e.g. app.html. -s, --spa file Path to a Single Page App, e.g. app.html.
-c, --compress Serve gzip-compressed resources, where applicable. -c, --compress Serve gzip-compressed resources, where applicable.
-b, --forbid path ... A list of forbidden routes. -b, --forbid path ... A list of forbidden routes.
-n, --no-cache Disable etag-based caching -forces loading from disk -n, --no-cache Disable etag-based caching -forces loading from disk each request.
each request.
--verbose Verbose output, useful for debugging. --verbose Verbose output, useful for debugging.
Misc <strong>Misc</strong>
-h, --help Print these usage instructions. -h, --help Print these usage instructions.
--config Print the stored config. --config Print the stored config.