add sitemap to repository (#8)

* add sitemap to repository

* fixed lint

* changes as per comments

* access hostname in appconfig in sitemxl.ts

* lint fix

* fixed dependencies sitemap

* update hostname

* lintfix

* fix lint by going to null option

* baseUrl has protocol and website name only

* added '/docs-toolkit' to url writen onto sitemap

* add prefix to nuxt schema and run  prepare

* define prefix in app.config.ts

* use prefix via appconfig into url in sitemap

* filter out terms: used suggestion from review

* lint fix

* Update nuxt.schema.ts

add JSDoc to show type of prefix is string

Co-authored-by: Nikolai Dorofeev <[email protected]>

* Update server/routes/sitemap.xml.ts

filter out draft pages

Co-authored-by: Nikolai Dorofeev <[email protected]>

* install UFO

* replace + with joinURL()

* update JSDoc for sitemap.baseUrl

* lint fix

* Apply suggestions from code review

Co-authored-by: Nikolai Dorofeev <[email protected]>

* removed +

* type check

* lint fix

* pre render sitemap.xml

* lint fix

* Update server/routes/sitemap.xml.ts

removed unneeded comment

Co-authored-by: Nikolai Dorofeev <[email protected]>

* removed prefix, updated sitemap

---------

Co-authored-by: Nikolai Dorofeev <[email protected]>

Author: Hdd87

nuxt.config.ts

@@ -33,7 +33,7 @@ export default defineNuxtConfig({
   modules: ['@nuxt/content', '@nuxtjs/tailwindcss', 'nuxt-icon'],
   nitro: {
     prerender: {
-      routes: ['/robots.txt']
+      routes: ['/robots.txt', '/sitemap.xml']
     }
   },
   content: {

nuxt.schema.ts

@@ -101,7 +101,7 @@ export default defineNuxtSchema({
           /**
            * Base URL for sitemap. All links in sitemap will be relative to this URL.
            *
-           * @example 'https://exactpro.github.io/docs-toolkit'
+           * @example 'https://exactpro.github.io'
            * @type {?string}
            */
           baseUrl: undefined

package-lock.json

@@ -60,6 +60,7 @@
     "nuxt": "^3.3.1",
     "nuxt-icon": "^0.3.3",
     "rehype-external-links": "^2.1.0",
+    "sitemap": "^7.1.1",
     "vue-gtag-next": "^1.14.0"
   }
 }

package.json

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2023 Exactpro (Exactpro Systems Limited)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SitemapStream, streamToPromise } from 'sitemap'
+import { joinURL, parseURL, withProtocol } from 'ufo'
+import { serverQueryContent } from '#content/server'
+const appConfig = useAppConfig()
+
+const path = parseURL(appConfig.exactproDocs.seo?.sitemap?.baseUrl ?? '')
+
+export default defineEventHandler(async (event) => {
+  // Fetch all documents
+  const docs = await serverQueryContent(event)
+    .where({ _partial: false, _draft: false })
+    .find()
+  if (!path.host || !path.protocol) {
+    throw new Error('host or protocol not found')
+  }
+  const sitemap = new SitemapStream({
+    hostname: withProtocol(path.host, path.protocol)
+  })
+
+  for (const doc of docs) {
+    if (!doc._path) {
+      continue
+    }
+    sitemap.write({
+      url: joinURL(path.pathname, doc._path),
+      changefreq: 'monthly'
+    })
+  }
+  sitemap.end()
+
+  return streamToPromise(sitemap)
+})