Merge pull request #14 from qazsato/add_description_option

Add description option

README.md

@@ -56,6 +56,7 @@ npx openapi-generate-html -i openapi.json --theme=dark
 | --ui          | "stoplight"    | Choose UI (stoplight / swagger / redoc) |
 | --theme       | "light"        | Choose Theme (light / dark)             |
 | --title       | "OpenAPI Docs" | Title of the HTML page                  |
+| --description |                | Description of the HTML page            |
 
 ## UI Pattern
 

package.json

@@ -17,7 +17,9 @@
   },
   "keywords": [
     "OpenAPI",
-    "Stoplight"
+    "Stoplight",
+    "Swagger",
+    "Redoc"
   ],
   "author": "qazsato <[email protected]>",
   "license": "MIT",

resources/redoc/template.ejs

@@ -4,6 +4,7 @@
   <title><%= title %></title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="description" content="<%= description %>">
   <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
   <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
   <style><%- cssContent %></style>

resources/stoplight/template.ejs

@@ -4,6 +4,7 @@
   <title><%= title %></title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="description" content="<%= description %>">
   <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
   <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
   <style><%- cssContent %></style>

resources/swagger/template.ejs

@@ -4,6 +4,7 @@
   <title><%= title %></title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="description" content="<%= description %>">
   <link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
   <style><%- cssContent %></style>
   <script>window.apiDocs = <%- apiDocs %></script>

src/index.js

@@ -52,6 +52,7 @@ function getCliOptions() {
     )
     .option('--ui <ui>', `Choose UI (${UI.join(', ')})`, validateCommandUi)
     .option('--title <title>', 'Title of the HTML page', 'OpenAPI Docs')
+    .option('--description <description>', 'Description of the HTML page', '')
     .option(
       '--theme <theme>',
       'Theme of the HTML page. Choose from light or dark.',
@@ -92,8 +93,6 @@ async function askQuestions(options) {
 
 async function renderOpenApiHtml(result) {
   const ui = result.ui
-  const theme = result.theme
-  const title = result.title
 
   const template = fs.readFileSync(
     path.resolve(__dirname, `../resources/${ui}/template.ejs`),
@@ -132,8 +131,9 @@ async function renderOpenApiHtml(result) {
   const apiDocs = await $RefParser.bundle(rawApiDocs)
 
   return ejs.render(template, {
-    theme,
-    title,
+    theme: result.theme,
+    title: result.title,
+    description: result.description,
     jsContent,
     cssContent,
     apiDocs: JSON.stringify(apiDocs),