Fix docma base path

feugy · Jan 28, 2018 · 349256d · 349256d
1 parent 6095f32
commit 349256d
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 10 deletions.
diff --git a/docma.config.json b/docma.config.json
@@ -12,7 +12,7 @@
   },
   "app": {
     "title": "Mini-utils documentation",
-    "base": "/docs",
+    "base": "/",
     "server": "github"
   },
   "template": {

diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html>
 <head>
     <title>Mini-utils documentation</title>
-    <base href="/docs/">
+    <base href="/">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="utf-8">
     <meta name="generator" content="Docma - https://github.com/onury/docma">

diff --git a/docs/js/docma-web.js b/docs/js/docma-web.js
diff --git a/lib/index.js b/lib/index.js
@@ -30,8 +30,9 @@ exports.getLogger = (opts = {}) => {
 }
 
 /**
- * @summary Extract declared parameter names from funciton signature
- * @description Lots of different signature are supported:
+ * Extract declared parameter names from funciton signature
+ *
+ * Lots of different signature are supported:
  * - `function` keyword, with or without function name
  * - "fat arrow" syntax, with or without parenthesis
  * - parameter with default values
@@ -118,8 +119,9 @@ exports.validateParams = (values, schema, id, expected) => {
 }
 
 /**
- * @summary Enrich validation error for a given API, with friendly message
- * @description When enriching validation error for:
+ * Enrich validation error for a given API, with friendly message
+ *
+ * When enriching validation error for:
  * - input parameters, a 400 (Bad Request) Boom error is returned
  * - returned results, a 512 (Bad Response) Boom error is returned
  *
@@ -168,7 +170,7 @@ exports.groupSchema = joi.object({
  *
  * API groups are objects compliant with mini-service-utils.groupSchema.
  * They could be specified in the `groups` property (options will be in `groupOpts`).
- * The specify parameter could be the group itself, mixed with the options
+ * The specify parameter could be the group itself, mixed with the options.
  *
  * @param {Object} opts         analyzed parameter
  * @return {ExtractionResult}   extracted groups
@@ -192,8 +194,9 @@ exports.extractGroups = opts => {
 }
 
 /**
- * @summary Extract validation objects for a given API
- * @description Each exposed API can have a Joi object assigned to validate received parameters/response
+ * Extract validation objects for a given API
+ *
+ * Each exposed API can have a Joi object assigned to validate received parameters/response
  * This validation object can be either:
  * - in the clause property of the API function
  * - in the clause property of the API group options