Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/bep/docuapi.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKhosrow Moossavi <khos2ow@gmail.com>2019-11-07 03:30:30 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-11-07 09:50:18 +0300
commit0ebea4ca9367218964879e4ab4ba29390ec4718b (patch)
tree3f07c14d8a3711f4117d0c64f4d5f2d6a90b99ba
parent2c5e6563f8100dd37301410cf95b4075a2b701d9 (diff)
Break down example site to smaller md files
-rw-r--r--exampleSite/content/kittens-specific.md71
-rw-r--r--exampleSite/content/kittens.md84
-rw-r--r--exampleSite/content/main.md147
3 files changed, 155 insertions, 147 deletions
diff --git a/exampleSite/content/kittens-specific.md b/exampleSite/content/kittens-specific.md
new file mode 100644
index 0000000..1143cc5
--- /dev/null
+++ b/exampleSite/content/kittens-specific.md
@@ -0,0 +1,71 @@
+---
+weight: 12
+title: Get a Specific Kitten
+---
+
+## Get a Specific Kitten
+
+```go
+package main
+
+import "github.com/bep/kittn/auth"
+
+func main() {
+ api := auth.Authorize("meowmeowmeow")
+
+ _ = api.GetKitten(2)
+}
+```
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```python
+import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get(2)
+```
+
+```shell
+curl "http://example.com/api/kittens/2"
+ -H "Authorization: meowmeowmeow"
+```
+
+```javascript
+const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let max = api.kittens.get(2);
+```
+
+> The above command returns JSON structured like this:
+
+```json
+{
+ "id": 2,
+ "name": "Max",
+ "breed": "unknown",
+ "fluffiness": 5,
+ "cuteness": 10
+}
+```
+
+This endpoint retrieves a specific kitten.
+
+<aside class="warning">Inside HTML code blocks like this one, you can't use Markdown, so use <code>&lt;code&gt;</code> blocks to denote code.</aside>
+
+### HTTP Request
+
+`GET http://example.com/kittens/<ID>`
+
+### URL Parameters
+
+Parameter | Description
+--------- | -----------
+ID | The ID of the kitten to retrieve
+
diff --git a/exampleSite/content/kittens.md b/exampleSite/content/kittens.md
new file mode 100644
index 0000000..f4d4a41
--- /dev/null
+++ b/exampleSite/content/kittens.md
@@ -0,0 +1,84 @@
+---
+weight: 11
+title: Kittens
+---
+
+# Kittens
+
+## Get All Kittens
+
+```go
+package main
+
+import "github.com/bep/kittn/auth"
+
+func main() {
+ api := auth.Authorize("meowmeowmeow")
+
+ _ = api.GetKittens()
+}
+```
+
+```ruby
+require 'kittn'
+
+api = Kittn::APIClient.authorize!('meowmeowmeow')
+api.kittens.get
+```
+
+```python
+import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get()
+```
+
+```shell
+curl "http://example.com/api/kittens"
+ -H "Authorization: meowmeowmeow"
+```
+
+```javascript
+const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let kittens = api.kittens.get();
+```
+
+> The above command returns JSON structured like this:
+
+```json
+[
+ {
+ "id": 1,
+ "name": "Fluffums",
+ "breed": "calico",
+ "fluffiness": 6,
+ "cuteness": 7
+ },
+ {
+ "id": 2,
+ "name": "Max",
+ "breed": "unknown",
+ "fluffiness": 5,
+ "cuteness": 10
+ }
+]
+```
+
+This endpoint retrieves all kittens.
+
+### HTTP Request
+
+`GET http://example.com/api/kittens`
+
+### Query Parameters
+
+Parameter | Default | Description
+--------- | ------- | -----------
+include_cats | false | If set to true, the result will also include cats.
+available | true | If set to false, the result will include kittens that have already been adopted.
+
+<aside class="success">
+Remember — a happy kitten is an authenticated kitten!
+</aside>
diff --git a/exampleSite/content/main.md b/exampleSite/content/main.md
index 933884b..bd7a0d3 100644
--- a/exampleSite/content/main.md
+++ b/exampleSite/content/main.md
@@ -63,150 +63,3 @@ Kittn expects for the API key to be included in all API requests to the server i
<aside class="notice">
You must replace <code>meowmeowmeow</code> with your personal API key.
</aside>
-
-# Kittens
-
-## Get All Kittens
-
-```go
-package main
-
-import "github.com/bep/kittn/auth"
-
-func main() {
- api := auth.Authorize("meowmeowmeow")
-
- _ = api.GetKittens()
-}
-```
-
-```ruby
-require 'kittn'
-
-api = Kittn::APIClient.authorize!('meowmeowmeow')
-api.kittens.get
-```
-
-```python
-import kittn
-
-api = kittn.authorize('meowmeowmeow')
-api.kittens.get()
-```
-
-```shell
-curl "http://example.com/api/kittens"
- -H "Authorization: meowmeowmeow"
-```
-
-```javascript
-const kittn = require('kittn');
-
-let api = kittn.authorize('meowmeowmeow');
-let kittens = api.kittens.get();
-```
-
-> The above command returns JSON structured like this:
-
-```json
-[
- {
- "id": 1,
- "name": "Fluffums",
- "breed": "calico",
- "fluffiness": 6,
- "cuteness": 7
- },
- {
- "id": 2,
- "name": "Max",
- "breed": "unknown",
- "fluffiness": 5,
- "cuteness": 10
- }
-]
-```
-
-This endpoint retrieves all kittens.
-
-### HTTP Request
-
-`GET http://example.com/api/kittens`
-
-### Query Parameters
-
-Parameter | Default | Description
---------- | ------- | -----------
-include_cats | false | If set to true, the result will also include cats.
-available | true | If set to false, the result will include kittens that have already been adopted.
-
-<aside class="success">
-Remember — a happy kitten is an authenticated kitten!
-</aside>
-
-## Get a Specific Kitten
-
-```go
-package main
-
-import "github.com/bep/kittn/auth"
-
-func main() {
- api := auth.Authorize("meowmeowmeow")
-
- _ = api.GetKitten(2)
-}
-```
-
-```ruby
-require 'kittn'
-
-api = Kittn::APIClient.authorize!('meowmeowmeow')
-api.kittens.get(2)
-```
-
-```python
-import kittn
-
-api = kittn.authorize('meowmeowmeow')
-api.kittens.get(2)
-```
-
-```shell
-curl "http://example.com/api/kittens/2"
- -H "Authorization: meowmeowmeow"
-```
-
-```javascript
-const kittn = require('kittn');
-
-let api = kittn.authorize('meowmeowmeow');
-let max = api.kittens.get(2);
-```
-
-> The above command returns JSON structured like this:
-
-```json
-{
- "id": 2,
- "name": "Max",
- "breed": "unknown",
- "fluffiness": 5,
- "cuteness": 10
-}
-```
-
-This endpoint retrieves a specific kitten.
-
-<aside class="warning">Inside HTML code blocks like this one, you can't use Markdown, so use <code>&lt;code&gt;</code> blocks to denote code.</aside>
-
-### HTTP Request
-
-`GET http://example.com/kittens/<ID>`
-
-### URL Parameters
-
-Parameter | Description
---------- | -----------
-ID | The ID of the kitten to retrieve
-