new stylesheet option for sitemap

Author: oscarotero

CHANGELOG.md

@@ -24,6 +24,7 @@ Go to the `v1` branch to see the changelog of Lume 1.
 - `katex`: `cssFile`, `placeholder` and `fontsFolder` option. The plugin downloads the CSS code.
 - `icons` plugin: Added css.gg and radix-ui.com/icons [#736]
 - `feed` plugin: Allow to pass an array of options or a function that return an array of options.
+- `sitemap` plugin: New option `stylesheet`.
 
 ### Changed
 - `Temporal` API is enabled by default.

plugins/sitemap.ts

@@ -19,6 +19,9 @@ export interface Options {
   /** The sitemap file name */
   filename?: string;
 
+  /** The xml-stylesheet document for styling */
+  stylesheet?: string;
+
   /**
    * The query to search pages included in the sitemap
    * @default "isRedirect!=true" excludes redirect pages produced by the redirects plugin
@@ -128,7 +131,15 @@ export function sitemap(userOptions?: Options) {
         },
       };
 
-      return stringify(sitemap);
+      const result = stringify(sitemap);
+      return options.stylesheet
+        ? result.replace(
+          '<?xml version="1.0" encoding="UTF-8"?>',
+          `<?xml version="1.0" encoding="UTF-8"?>\n<?xml-stylesheet type="text/xsl" href="${
+            site.url(options.stylesheet)
+          }"?>`,
+        )
+        : result;
     }
   };
 }

tests/__snapshots__/sitemap.test.ts.snap

@@ -436,6 +436,7 @@ Sitemap: https://example.com/sitemap.xml",
   },
   {
     content: '<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="/sitemap-style.xml"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>https://example.com/overrided-page2/</loc>
@@ -465,6 +466,7 @@ Sitemap: https://example.com/sitemap.xml",
     data: {
       basename: "sitemap",
       content: '<?xml version="1.0" encoding="UTF-8"?>
+<?xml-stylesheet type="text/xsl" href="/sitemap-style.xml"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>https://example.com/overrided-page2/</loc>

tests/sitemap.test.ts

@@ -11,7 +11,9 @@ Deno.test("Sitemap plugin", async (t) => {
     location: new URL("https://example.com/"),
   });
 
-  site.use(sitemap());
+  site.use(sitemap({
+    stylesheet: "/sitemap-style.xml",
+  }));
   site.use(extractDate());
   site.ignore("static.yml");