Merge pull request #346 from nstapelbroek/set-apidocs-title

feat: use config.Info.Title as the page title in the API docs
danielgtaylor · Apr 1, 2024 · ee299ec · ee299ec
2 parents 10e15d1 + 4c998f3
commit ee299ec
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/api.go b/api.go
@@ -412,13 +412,17 @@ func NewAPI(config Config, a Adapter) API {
 				openAPIPath = path.Join(prefix, openAPIPath)
 			}
 			ctx.SetHeader("Content-Type", "text/html")
+			title := "Elements in HTML"
+			if config.Info != nil && config.Info.Title != "" {
+				title = config.Info.Title + " Reference"
+			}
 			ctx.BodyWriter().Write([]byte(`<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
     <meta name="referrer" content="same-origin" />
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
-    <title>Elements in HTML</title>
+    <title>` + title + `</title>
     <!-- Embed elements Elements via Web Component -->
     <link href="https://unpkg.com/@stoplight/[email protected]/styles.min.css" rel="stylesheet" />
     <script src="https://unpkg.com/@stoplight/[email protected]/web-components.min.js"

diff --git a/docs/docs/features/api-docs.md b/docs/docs/features/api-docs.md
@@ -37,7 +37,7 @@ router.Get("/docs", func(w http.ResponseWriter, r *http.Request) {
     <meta charset="utf-8" />
     <meta name="referrer" content="same-origin" />
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
-    <title>Elements in HTML</title>
+    <title>Docs Example reference</title>
     <!-- Embed elements Elements via Web Component -->
     <link href="https://unpkg.com/@stoplight/[email protected]/styles.min.css" rel="stylesheet" />
     <script src="https://unpkg.com/@stoplight/[email protected]/web-components.min.js"