docula 1.6.0 → 1.7.0

package/dist/docula.d.ts

@@ -363,6 +363,9 @@ declare class DoculaBuilder {
     buildRobotsPage(options: DoculaOptions): Promise<void>;
     buildSiteMapPage(data: DoculaData): Promise<void>;
     buildFeedPage(data: DoculaData): Promise<void>;
+    buildChangelogFeedJson(data: DoculaData): Promise<void>;
+    buildChangelogLatestFeedJson(data: DoculaData): Promise<void>;
+    private writeChangelogFeedJson;
     buildLlmsFiles(data: DoculaData): Promise<void>;
     private generateLlmsIndexContent;
     private generateLlmsFullContent;

package/dist/docula.js

@@ -1360,6 +1360,12 @@ var DoculaBuilder = class {
       await this.buildFeedPage(doculaData);
       this._console.fileBuilt("feed.xml");
     }
+    if (doculaData.hasChangelog && doculaData.templates?.changelogEntry) {
+      await this.buildChangelogFeedJson(doculaData);
+      this._console.fileBuilt("changelog.json");
+      await this.buildChangelogLatestFeedJson(doculaData);
+      this._console.fileBuilt("changelog-latest.json");
+    }
     if (doculaData.hasDocuments) {
       this._console.step("Building documentation pages...");
       await this.buildDocsPages(doculaData);
@@ -1580,6 +1586,12 @@ var DoculaBuilder = class {
     if (data.documents?.length) {
       urls.push({ url: `${data.siteUrl}${data.baseUrl}/feed.xml` });
     }
+    if (data.hasChangelog && data.templates?.changelogEntry) {
+      urls.push({ url: `${data.siteUrl}${data.baseUrl}/changelog.json` });
+      urls.push({
+        url: `${data.siteUrl}${data.baseUrl}/changelog-latest.json`
+      });
+    }
     if (data.openApiUrl && data.templates?.api) {
       urls.push({
         url: `${data.siteUrl}${data.apiUrl}`
@@ -1663,6 +1675,73 @@ var DoculaBuilder = class {
     await fs3.promises.mkdir(data.output, { recursive: true });
     await fs3.promises.writeFile(feedPath, xml, "utf8");
   }
+  async buildChangelogFeedJson(data) {
+    const entries = data.changelogEntries;
+    if (!entries?.length) {
+      return;
+    }
+    await this.writeChangelogFeedJson(data, entries, "changelog.json");
+  }
+  async buildChangelogLatestFeedJson(data) {
+    const entries = data.changelogEntries;
+    if (!entries?.length) {
+      return;
+    }
+    const latestEntries = entries.slice(0, this.options.changelogPerPage);
+    await this.writeChangelogFeedJson(
+      data,
+      latestEntries,
+      "changelog-latest.json"
+    );
+  }
+  async writeChangelogFeedJson(data, entries, filename) {
+    const feedUrl = this.buildAbsoluteSiteUrl(
+      data.siteUrl,
+      `${data.baseUrl}/${filename}`
+    );
+    const homeUrl = this.buildAbsoluteSiteUrl(data.siteUrl, `${data.baseUrl}/`);
+    const items = entries.map((entry) => {
+      const itemUrl = this.buildAbsoluteSiteUrl(
+        data.siteUrl,
+        `${data.changelogUrl}/${entry.slug}/`
+      );
+      const item = {
+        id: entry.slug,
+        title: entry.title,
+        url: itemUrl,
+        date_published: entry.date,
+        date_modified: entry.lastModified,
+        summary: entry.preview
+      };
+      if (entry.generatedHtml) {
+        item.content_html = entry.generatedHtml;
+      }
+      if (entry.content) {
+        item.content_text = entry.content;
+      }
+      if (entry.tag) {
+        item.tags = [entry.tag];
+      }
+      if (entry.previewImage) {
+        item.image = entry.previewImage;
+      }
+      return item;
+    });
+    const feed = {
+      version: "https://jsonfeed.org/version/1.1",
+      title: data.siteTitle,
+      description: data.siteDescription,
+      home_page_url: homeUrl,
+      feed_url: feedUrl,
+      items
+    };
+    await fs3.promises.mkdir(data.output, { recursive: true });
+    await fs3.promises.writeFile(
+      `${data.output}/${filename}`,
+      JSON.stringify(feed, null, 2),
+      "utf8"
+    );
+  }
   async buildLlmsFiles(data) {
     if (!this.options.enableLlmsTxt) {
       return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docula",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "main": "./dist/docula.js",