Skip to content

Commit

Permalink
fix: doc site (#1393)
Browse files Browse the repository at this point in the history
* Update docs for jekyll rendering
* Remove unusued submodules
  • Loading branch information
William Blankenship committed Jul 4, 2017
1 parent 5d7039a commit 76ee548
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 120 deletions.
9 changes: 0 additions & 9 deletions .gitmodules

This file was deleted.

1 change: 0 additions & 1 deletion deps/restdown
Submodule restdown deleted from 34a843
5 changes: 4 additions & 1 deletion docs/pages/components/plugins.md → docs/api/plugins.md
@@ -1,4 +1,7 @@
# restify-plugins
---
title: Plugins API
permalink: /docs/plugins-api/
---

Restify comes bundled with a selection of useful plugins. These are accessible
off of `restify.plugins` and `restify.pre`.
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/components/request.md → docs/api/request.md
@@ -1,4 +1,7 @@
# Request API
---
title: Request API
permalink: /docs/request-api/
---

Wraps all of the node
[http.IncomingMessage](http://nodejs.org/api/http.html#http_http_incomingmessage)
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/components/response.md → docs/api/response.md
@@ -1,4 +1,7 @@
# Response API
---
title: Response API
permalink: /docs/response-api/
---

Wraps all of the node
[ServerResponse](http://nodejs.org/docs/latest/api/http.html#http.ServerResponse)
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/components/server.md → docs/api/server.md
@@ -1,4 +1,7 @@
# Creating a server
---
title: Server API
permalink: /docs/server-api/
---

A restify server object is the main interface through which you will register
routes and handlers for incoming requests. A server object will be returned
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/guides/client.md → docs/guides/client.md
@@ -1,4 +1,7 @@
# Client Guide
---
title: Client Guide
permalink: /docs/client-guide/
---

There are actually three separate clients shipped in restify:

Expand Down
7 changes: 5 additions & 2 deletions docs/pages/guides/dtrace.md → docs/guides/dtrace.md
@@ -1,4 +1,7 @@
# DTrace
---
title: Dtrace
permalink: /docs/dtrace/
---

One of the coolest features of restify is that it automatically
creates DTrace probes for you whenever you add a new route/handler.
Expand Down Expand Up @@ -204,4 +207,4 @@ value ------------- Distribution ------------- count
128 |@@@@ 1
256 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 9
512 |
```
```
6 changes: 5 additions & 1 deletion docs/pages/guides/server.md → docs/index.md
@@ -1,4 +1,8 @@
# Server Guide
---
title: Quick Start
permalink: /docs/home/
redirect_from: /docs/
---

Setting up a server is quick and easy. Here is a barebones echo server:

Expand Down
9 changes: 0 additions & 9 deletions docs/pages/guides/getting-started.md

This file was deleted.

93 changes: 0 additions & 93 deletions docs/pages/index.md

This file was deleted.

0 comments on commit 76ee548

Please sign in to comment.