Format

Kevin Richter · Kevin Richter · commit 72c805928ad1 · 2018-08-14T09:47:39.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -16,7 +16,6 @@ build/
 .cache
 .vagrant
 .sass-cache
-source/*.md
 source/wrapper
 
 # YARD artifacts
diff --git a/source/includes/_directory.md b/source/includes/_directory.md
diff --git a/source/includes/v1/_directory.md b/source/includes/v1/_directory.md
@@ -0,0 +1,7 @@
+# Pages
+
+ - [Home](index.html)
+ - [API](api.html)
+   - [API OpenAPI (Swagger) Definition](api/index.html)
+ - [API Wrapper](wrapper.html)
+   - [API Wrapper Class Documentation](/wrapper/index.html)
diff --git a/source/index.html b/source/index.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0;url=/v1/" />
+  </head>
+  <body>
+    <a href="/v1/">Click here to go to the /v1/ documentation if you're not redirected automatically.</a>
+  </body>
+</html>
diff --git a/source/v1/api.html.md b/source/v1/api.html.md
@@ -10,7 +10,7 @@ toc_footers:
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
 
 includes:
-  - directory
+  - v1/directory
 
 search: true
 ---
@@ -19,7 +19,6 @@ search: true
 
 ...
 
-
 # Return Data
 
 > For Success Responses
diff --git a/source/v1/api/index.html b/source/v1/api/index.html
diff --git a/source/v1/dispatcher.html.md b/source/v1/dispatcher.html.md
@@ -6,7 +6,7 @@ toc_footers:
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
   
 includes:
-  - directory
+  - v1/directory
 
 search: true
 ---
diff --git a/source/v1/examples.html.md b/source/v1/examples.html.md
@@ -10,7 +10,7 @@ toc_footers:
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
 
 includes:
-  - directory
+  - v1/directory
 
 search: true
 ---
@@ -19,7 +19,7 @@ search: true
 
 ## Building a Map
 
-```Wrapper
+```javascript--wrapper
 const api = window.api;
 ```
 
@@ -34,7 +34,7 @@ const job = await api.jobs.new({
 }).save();
 ```
 
-First a [`Job`](/api/index.html#JobCreateRequest). A Job is a project on the Maps4News Platform.
+First a [`Job`](api/index.html#JobCreateRequest). A Job is a project on the Maps4News Platform.
 
 <br/><br/><br/><br/>
 
@@ -45,11 +45,11 @@ const revision = await job.revisions.new({
 }).save(mapObject);
 ```
 
-Second a [`Job Revision`](/api/index.html#JobRevisionCreateRequest). A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.
+Second a [`Job Revision`](api/index.html#JobRevisionCreateRequest). A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.
 
 A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.
 
-Details about how to build a map object can be found on the [map object page](/dispatcher.html).
+Details about how to build a map object can be found on the [map object page](dispatcher.html).
 
 <br/>
 
diff --git a/source/v1/index.html.md b/source/v1/index.html.md
@@ -10,7 +10,7 @@ toc_footers:
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
   
 includes:
-  - directory
+  - v1/directory
 
 search: true
 ---
@@ -34,7 +34,7 @@ We have created a query builder-like library that is able to do everything our A
 
 The library is freely available on [github](https://github.com/MapCreatorEU/api-wrapper) and [npm](https://www.npmjs.com/package/@mapcreator/maps4news).
 
-More information about the wrapper can be found on [this page](/wrapper.html)
+More information about the wrapper can be found on [this page](wrapper.html)
 
 # Authentication
 
@@ -123,7 +123,7 @@ You must have a valid client registered with us to be able to use the API. Clien
 
 The next step in learning about our API would be to look into our OpenAPI documentation about all the available endpoints.
 
-[API OpenAPI (Swagger) Definition](/api/index.html)
+[API OpenAPI (Swagger) Definition](api/index.html)
 
 Our you can look into how the wrapper works.
 
diff --git a/source/v1/wrapper.html.md b/source/v1/wrapper.html.md
@@ -6,7 +6,7 @@ toc_footers:
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
   
 includes:
-  - directory
+  - v1/directory
 
 search: true
 ---
@@ -86,7 +86,7 @@ const token = "...";
 const api = new Maps4News(token);
 ```
 
-A machine token can be used directly while instaciating the api instance. 
+A machine token can be used directly while instantiating the api instance. 
 
 ## Implicit flow
 
@@ -273,15 +273,17 @@ const job = await api.jobs.new({
 }).save();
 
 const revision = await job.revisions.new({
-	mapstyleSetId: 1
+  mapstyleSetId: 1
 }).save(object);
 
 // Will resolve when the request finishes. Not when the build is done. 
 await revision.build("https://example.com/callback"); 
 ```
 
-Creating a new job and building it is pretty straight foreward. Revisions are slightly different then other resource instances. Their save function requires the new map definition as an argument. This is to make it easier to re-use the same revision instance.  
-
+Creating a new job and building it is pretty straight forward.
+Revisions are slightly different then other resource instances.
+Their save function requires the new map definition as an argument.
+This is to make it easier to re-use the same revision instance.
 
 ## Pagination
 
@@ -369,4 +371,4 @@ api.layers.search(query).then(console.dir);
 The `search` method is an extension of `list`. This means that `.search({})` is the same as 
 `list()`. More information about search query formatting can be found in the api documentation.
  
-[api documepntation]: https://api.beta.maps4news.com/docs/
+[api documentation]: https://api.beta.maps4news.com/docs/

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<html>
 +  <head>
 +    <meta http-equiv="refresh" content="0;url=/v1/" />
 +  </head>
 +  <body>
 +    <a href="/v1/">Click here to go to the /v1/ documentation if you're not redirected automatically.</a>
 +  </body>
 +</html>