docula 1.5.0 → 1.7.0

package/dist/docula.d.ts

@@ -215,9 +215,23 @@ declare class DoculaOptions {
      */
     autoUpdateIgnores: boolean;
     /**
-     * File extensions to copy as assets from docs/ and changelog/ directories.
-     * Override in docula.config to customize.
+     * Base URL path prefix for all generated paths (e.g., "/docs").
+     * When set, all asset and navigation URLs are prefixed with this path.
+     */
+    baseUrl: string;
+    /**
+     * Output subdirectory and URL segment for documentation pages.
+     * Set to empty string to place docs at the output root.
+     */
+    docsPath: string;
+    /**
+     * Output subdirectory and URL segment for API reference pages.
+     */
+    apiPath: string;
+    /**
+     * Output subdirectory and URL segment for changelog pages.
      */
+    changelogPath: string;
     /**
      * Cookie-based authentication. When set, shows a Login/Logout button
      * in the header based on whether a JWT cookie is present.
@@ -297,6 +311,13 @@ type DoculaData = {
     enableLlmsTxt?: boolean;
     hasFeed?: boolean;
     lastModified?: string;
+    baseUrl: string;
+    docsPath: string;
+    apiPath: string;
+    changelogPath: string;
+    docsUrl: string;
+    apiUrl: string;
+    changelogUrl: string;
 };
 type DoculaTemplates = {
     home: string;
@@ -342,9 +363,13 @@ 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;
+    private buildUrlPath;
     private buildAbsoluteSiteUrl;
     private normalizePathForUrl;
     private escapeXml;

package/dist/docula.js

@@ -907,6 +907,18 @@ var Github = class {
 // src/options.ts
 import path3 from "path";
 import process3 from "process";
+function trimSlashes(value) {
+  let start = 0;
+  let end = value.length;
+  while (start < end && value[start] === "/") start++;
+  while (end > start && value[end - 1] === "/") end--;
+  return value.slice(start, end);
+}
+function trimTrailingSlashes(value) {
+  let end = value.length;
+  while (end > 0 && value[end - 1] === "/") end--;
+  return value.slice(0, end);
+}
 var DoculaOptions = class {
   /**
    * Name of the built-in template to use (e.g., "modern", "classic")
@@ -979,9 +991,23 @@ var DoculaOptions = class {
    */
   autoUpdateIgnores = true;
   /**
-   * File extensions to copy as assets from docs/ and changelog/ directories.
-   * Override in docula.config to customize.
+   * Base URL path prefix for all generated paths (e.g., "/docs").
+   * When set, all asset and navigation URLs are prefixed with this path.
    */
+  baseUrl = "";
+  /**
+   * Output subdirectory and URL segment for documentation pages.
+   * Set to empty string to place docs at the output root.
+   */
+  docsPath = "docs";
+  /**
+   * Output subdirectory and URL segment for API reference pages.
+   */
+  apiPath = "api";
+  /**
+   * Output subdirectory and URL segment for changelog pages.
+   */
+  changelogPath = "changelog";
   /**
    * Cookie-based authentication. When set, shows a Login/Logout button
    * in the header based on whether a JWT cookie is present.
@@ -1096,6 +1122,18 @@ var DoculaOptions = class {
     if (options.cache && typeof options.cache === "object" && options.cache.github !== null && typeof options.cache.github === "object" && typeof options.cache.github.ttl === "number") {
       this.cache = options.cache;
     }
+    if (options.baseUrl !== void 0 && typeof options.baseUrl === "string") {
+      this.baseUrl = trimTrailingSlashes(options.baseUrl);
+    }
+    if (options.docsPath !== void 0 && typeof options.docsPath === "string") {
+      this.docsPath = trimSlashes(options.docsPath);
+    }
+    if (options.apiPath !== void 0 && typeof options.apiPath === "string") {
+      this.apiPath = trimSlashes(options.apiPath);
+    }
+    if (options.changelogPath !== void 0 && typeof options.changelogPath === "string") {
+      this.changelogPath = trimSlashes(options.changelogPath);
+    }
     if (options.allowedAssets && Array.isArray(options.allowedAssets)) {
       this.allowedAssets = options.allowedAssets;
     }
@@ -1207,14 +1245,28 @@ var DoculaBuilder = class {
       themeMode: this.options.themeMode,
       cookieAuth: this.options.cookieAuth,
       headerLinks: this.options.headerLinks,
-      enableLlmsTxt: this.options.enableLlmsTxt
+      enableLlmsTxt: this.options.enableLlmsTxt,
+      baseUrl: this.options.baseUrl,
+      docsPath: this.options.docsPath,
+      apiPath: this.options.apiPath,
+      changelogPath: this.options.changelogPath,
+      docsUrl: this.buildUrlPath(this.options.baseUrl, this.options.docsPath),
+      apiUrl: this.buildUrlPath(this.options.baseUrl, this.options.apiPath),
+      changelogUrl: this.buildUrlPath(
+        this.options.baseUrl,
+        this.options.changelogPath
+      )
     };
     const readmePath = `${this.options.sitePath}/README.md`;
     if (doculaData.hasReadme) {
       currentAssetHashes["README.md"] = this.hashFile(readmePath);
     }
     if (!doculaData.openApiUrl && fs3.existsSync(`${doculaData.sitePath}/api/swagger.json`)) {
-      doculaData.openApiUrl = "/api/swagger.json";
+      doculaData.openApiUrl = this.buildUrlPath(
+        this.options.baseUrl,
+        this.options.apiPath,
+        "swagger.json"
+      );
     }
     if (this.options.githubPath) {
       doculaData.github = await this.getGithubData(this.options.githubPath);
@@ -1308,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);
@@ -1318,15 +1376,17 @@ var DoculaBuilder = class {
     if (doculaData.hasApi) {
       this._console.step("Building API page...");
       await this.buildApiPage(doculaData);
-      this._console.fileBuilt("api/index.html");
+      this._console.fileBuilt(`${this.options.apiPath}/index.html`);
     }
     if (doculaData.hasChangelog) {
       this._console.step("Building changelog...");
       await this.buildChangelogPage(doculaData);
-      this._console.fileBuilt("changelog/index.html");
+      this._console.fileBuilt(`${this.options.changelogPath}/index.html`);
       await this.buildChangelogEntryPages(doculaData);
       for (const entry of doculaData.changelogEntries ?? []) {
-        this._console.fileBuilt(`changelog/${entry.slug}/index.html`);
+        this._console.fileBuilt(
+          `${this.options.changelogPath}/${entry.slug}/index.html`
+        );
       }
     }
     const siteRelativePath = this.options.sitePath;
@@ -1416,7 +1476,7 @@ var DoculaBuilder = class {
     );
     this.copyContentAssets(
       `${doculaData.sitePath}/changelog`,
-      `${this.options.output}/changelog`
+      `${this.options.output}/${this.options.changelogPath}`
     );
     if (doculaData.documents?.length) {
       this.copyDocumentSiblingAssets(doculaData);
@@ -1524,13 +1584,23 @@ var DoculaBuilder = class {
     const sitemapPath = `${data.output}/sitemap.xml`;
     const urls = [{ url: data.siteUrl }];
     if (data.documents?.length) {
-      urls.push({ url: `${data.siteUrl}/feed.xml` });
+      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}/api` });
+      urls.push({
+        url: `${data.siteUrl}${data.apiUrl}`
+      });
     }
     if (data.hasChangelog && data.templates?.changelog) {
-      urls.push({ url: `${data.siteUrl}/changelog` });
+      urls.push({
+        url: `${data.siteUrl}${data.changelogUrl}`
+      });
       const perPage = this.options.changelogPerPage;
       const totalPages = Math.max(
         1,
@@ -1538,12 +1608,12 @@ var DoculaBuilder = class {
       );
       for (let page = 2; page <= totalPages; page++) {
         urls.push({
-          url: `${data.siteUrl}/changelog/page/${page}`
+          url: `${data.siteUrl}${data.changelogUrl}/page/${page}`
         });
       }
       for (const entry of data.changelogEntries ?? []) {
         urls.push({
-          url: `${data.siteUrl}/changelog/${entry.slug}`
+          url: `${data.siteUrl}${data.changelogUrl}/${entry.slug}`
         });
       }
     }
@@ -1552,7 +1622,7 @@ var DoculaBuilder = class {
       if (urlPath.endsWith("index.html")) {
         urlPath = urlPath.slice(0, -10);
       }
-      urls.push({ url: `${data.siteUrl}${urlPath}` });
+      urls.push({ url: `${data.siteUrl}${data.baseUrl}${urlPath}` });
     }
     let xml = '<?xml version="1.0" encoding="UTF-8"?>';
     xml += '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
@@ -1570,8 +1640,14 @@ var DoculaBuilder = class {
       return;
     }
     const feedPath = `${data.output}/feed.xml`;
-    const channelLink = this.buildAbsoluteSiteUrl(data.siteUrl, "/");
-    const feedUrl = this.buildAbsoluteSiteUrl(data.siteUrl, "/feed.xml");
+    const channelLink = this.buildAbsoluteSiteUrl(
+      data.siteUrl,
+      `${data.baseUrl}/`
+    );
+    const feedUrl = this.buildAbsoluteSiteUrl(
+      data.siteUrl,
+      `${data.baseUrl}/feed.xml`
+    );
     let xml = '<?xml version="1.0" encoding="UTF-8"?>';
     xml += '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">';
     xml += "<channel>";
@@ -1584,7 +1660,7 @@ var DoculaBuilder = class {
       const itemTitle = document.navTitle || document.title || document.urlPath;
       const itemLink = this.buildAbsoluteSiteUrl(
         data.siteUrl,
-        this.normalizePathForUrl(document.urlPath)
+        `${data.baseUrl}${this.normalizePathForUrl(document.urlPath)}`
       );
       const summary = document.description || this.summarizeMarkdown(new Writr(document.content).body);
       xml += "<item>";
@@ -1599,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;
@@ -1642,7 +1785,7 @@ var DoculaBuilder = class {
     lines.push(data.siteDescription);
     lines.push("");
     lines.push(
-      `- [Full LLM Content](${this.buildAbsoluteSiteUrl(data.siteUrl, "/llms-full.txt")})`
+      `- [Full LLM Content](${this.buildAbsoluteSiteUrl(data.siteUrl, `${data.baseUrl}/llms-full.txt`)})`
     );
     lines.push("");
     lines.push("## Documentation");
@@ -1650,7 +1793,7 @@ var DoculaBuilder = class {
       for (const document of documents) {
         const documentUrl = this.buildAbsoluteSiteUrl(
           data.siteUrl,
-          this.normalizePathForUrl(document.urlPath)
+          `${data.baseUrl}${this.normalizePathForUrl(document.urlPath)}`
         );
         const description = document.description ? ` - ${document.description}` : "";
         lines.push(`- [${document.navTitle}](${documentUrl})${description}`);
@@ -1662,7 +1805,7 @@ var DoculaBuilder = class {
     lines.push("## API Reference");
     if (data.hasApi) {
       lines.push(
-        `- [API Documentation](${this.buildAbsoluteSiteUrl(data.siteUrl, "/api")})`
+        `- [API Documentation](${this.buildAbsoluteSiteUrl(data.siteUrl, data.apiUrl)})`
       );
     } else {
       lines.push("- Not available.");
@@ -1671,12 +1814,12 @@ var DoculaBuilder = class {
     lines.push("## Changelog");
     if (data.hasChangelog) {
       lines.push(
-        `- [Changelog](${this.buildAbsoluteSiteUrl(data.siteUrl, "/changelog")})`
+        `- [Changelog](${this.buildAbsoluteSiteUrl(data.siteUrl, data.changelogUrl)})`
       );
       for (const entry of changelogEntries.slice(0, 20)) {
         const date = entry.formattedDate || entry.date || "No date";
         lines.push(
-          `- [${entry.title}](${this.buildAbsoluteSiteUrl(data.siteUrl, `/changelog/${entry.slug}`)}) (${date})`
+          `- [${entry.title}](${this.buildAbsoluteSiteUrl(data.siteUrl, `${data.changelogUrl}/${entry.slug}`)}) (${date})`
         );
       }
     } else {
@@ -1694,7 +1837,7 @@ var DoculaBuilder = class {
     lines.push(data.siteDescription);
     lines.push("");
     lines.push(
-      `Source Index: ${this.buildAbsoluteSiteUrl(data.siteUrl, "/llms.txt")}`
+      `Source Index: ${this.buildAbsoluteSiteUrl(data.siteUrl, `${data.baseUrl}/llms.txt`)}`
     );
     lines.push("");
     lines.push("## Documentation");
@@ -1702,7 +1845,7 @@ var DoculaBuilder = class {
       for (const document of documents) {
         const documentUrl = this.buildAbsoluteSiteUrl(
           data.siteUrl,
-          this.normalizePathForUrl(document.urlPath)
+          `${data.baseUrl}${this.normalizePathForUrl(document.urlPath)}`
         );
         const markdownBody = new Writr(document.content).body.trim();
         lines.push("");
@@ -1720,7 +1863,9 @@ var DoculaBuilder = class {
     lines.push("");
     lines.push("## API Reference");
     if (data.hasApi) {
-      lines.push(`URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, "/api")}`);
+      lines.push(
+        `URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, data.apiUrl)}`
+      );
       lines.push("");
       const localOpenApiSpec = await this.getSafeLocalOpenApiSpec(data);
       if (localOpenApiSpec) {
@@ -1742,13 +1887,13 @@ var DoculaBuilder = class {
     lines.push("## Changelog");
     if (data.hasChangelog && changelogEntries.length > 0) {
       lines.push(
-        `URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, "/changelog")}`
+        `URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, data.changelogUrl)}`
       );
       for (const entry of changelogEntries) {
         lines.push("");
         lines.push(`### ${entry.title}`);
         lines.push(
-          `URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, `/changelog/${entry.slug}`)}`
+          `URL: ${this.buildAbsoluteSiteUrl(data.siteUrl, `${data.changelogUrl}/${entry.slug}`)}`
         );
         if (entry.formattedDate || entry.date) {
           lines.push(`Date: ${entry.formattedDate || entry.date}`);
@@ -1765,6 +1910,16 @@ var DoculaBuilder = class {
     lines.push("");
     return lines.join("\n");
   }
+  buildUrlPath(...segments) {
+    const cleaned = segments.filter((s) => Boolean(s)).map((s) => {
+      let start = 0;
+      let end = s.length;
+      while (start < end && s[start] === "/") start++;
+      while (end > start && s[end - 1] === "/") end--;
+      return s.slice(start, end);
+    });
+    return `/${cleaned.filter(Boolean).join("/")}`;
+  }
   buildAbsoluteSiteUrl(siteUrl, urlPath) {
     const normalizedSiteUrl = siteUrl.endsWith("/") ? siteUrl.slice(0, -1) : siteUrl;
     const normalizedPath = urlPath.startsWith("/") ? urlPath : `/${urlPath}`;
@@ -1949,7 +2104,9 @@ var DoculaBuilder = class {
   async buildDocsPages(data) {
     if (data.templates && data.documents?.length) {
       const documentsTemplate = `${data.templatePath}/${data.templates.docPage}`;
-      await fs3.promises.mkdir(`${data.output}/docs`, { recursive: true });
+      const resolvedDocsPath = data.docsPath;
+      const docsOutputDir = resolvedDocsPath ? `${data.output}/${resolvedDocsPath}` : `${data.output}`;
+      await fs3.promises.mkdir(docsOutputDir, { recursive: true });
       data.sidebarItems = this.generateSidebarItems(data);
       const promises = data.documents.map(async (document) => {
         const folder = document.urlPath.split("/").slice(0, -1).join("/");
@@ -1974,7 +2131,7 @@ var DoculaBuilder = class {
       throw new Error("No API template or openApiUrl found");
     }
     const swaggerSource = `${data.sitePath}/api/swagger.json`;
-    const apiOutputPath = `${data.output}/api`;
+    const apiOutputPath = `${data.output}/${data.apiPath}`;
     await fs3.promises.mkdir(apiOutputPath, { recursive: true });
     if (fs3.existsSync(swaggerSource)) {
       await fs3.promises.copyFile(
@@ -2016,7 +2173,7 @@ var DoculaBuilder = class {
     if (!data.openApiUrl || !data.templates?.api) {
       return;
     }
-    const apiPath = `${data.output}/api/index.html`;
+    const apiPath = `${data.output}/${data.apiPath}/index.html`;
     const apiContent = await this.renderApiContent(data);
     await fs3.promises.writeFile(apiPath, apiContent, "utf8");
   }
@@ -2103,7 +2260,7 @@ var DoculaBuilder = class {
       generatedHtml: new Writr(markdownContent).renderSync({ mdx: isMdx }),
       preview: this.generateChangelogPreview(markdownContent, 500, isMdx),
       previewImage,
-      urlPath: `/changelog/${slug}/index.html`,
+      urlPath: `/${this.options.changelogPath}/${slug}/index.html`,
       lastModified: fs3.statSync(filePath).mtime.toISOString().split("T")[0]
     };
   }
@@ -2200,7 +2357,7 @@ var DoculaBuilder = class {
       content: body,
       generatedHtml: new Writr(body).renderSync(),
       preview: this.generateChangelogPreview(body),
-      urlPath: `/changelog/${slug}/index.html`,
+      urlPath: `/${this.options.changelogPath}/${slug}/index.html`,
       lastModified: dateString
     };
   }
@@ -2226,7 +2383,8 @@ var DoculaBuilder = class {
     for (let page = 1; page <= totalPages; page++) {
       const startIndex = (page - 1) * perPage;
       const pageEntries = allEntries.slice(startIndex, startIndex + perPage);
-      const outputPath = page === 1 ? `${data.output}/changelog` : `${data.output}/changelog/page/${page}`;
+      const changelogOutputBase = `${data.output}/${data.changelogPath}`;
+      const outputPath = page === 1 ? changelogOutputBase : `${changelogOutputBase}/page/${page}`;
       const indexPath = `${outputPath}/index.html`;
       const paginationData = {
         ...data,
@@ -2236,8 +2394,8 @@ var DoculaBuilder = class {
         hasPagination: totalPages > 1,
         hasNextPage: page < totalPages,
         hasPrevPage: page > 1,
-        nextPageUrl: page < totalPages ? `/changelog/page/${page + 1}/` : "",
-        prevPageUrl: page > 1 ? page === 2 ? "/changelog/" : `/changelog/page/${page - 1}/` : ""
+        nextPageUrl: page < totalPages ? `${data.changelogUrl}/page/${page + 1}/` : "",
+        prevPageUrl: page > 1 ? page === 2 ? `${data.changelogUrl}/` : `${data.changelogUrl}/page/${page - 1}/` : ""
       };
       promises.push(
         (async () => {
@@ -2259,7 +2417,7 @@ var DoculaBuilder = class {
     }
     const entryTemplate = `${data.templatePath}/${data.templates.changelogEntry}`;
     const promises = data.changelogEntries.map(async (entry) => {
-      const entryOutputPath = `${data.output}/changelog/${entry.slug}`;
+      const entryOutputPath = `${data.output}/${data.changelogPath}/${entry.slug}`;
       await fs3.promises.mkdir(entryOutputPath, { recursive: true });
       const entryContent = await this._ecto.renderFromFile(
         entryTemplate,
@@ -2281,7 +2439,7 @@ var DoculaBuilder = class {
     for (const document of data.documents ?? []) {
       if (document.isRoot) {
         sidebarItems.unshift({
-          path: document.urlPath.replace("index.html", ""),
+          path: `${data.baseUrl}${document.urlPath.replace("index.html", "")}`,
           name: document.navTitle,
           order: document.order
         });
@@ -2303,7 +2461,7 @@ var DoculaBuilder = class {
         }
         sidebarItems[sectionIndex].children ??= [];
         sidebarItems[sectionIndex].children.push({
-          path: document.urlPath.replace("index.html", ""),
+          path: `${data.baseUrl}${document.urlPath.replace("index.html", "")}`,
           name: document.navTitle,
           order: document.order
         });
@@ -2425,13 +2583,19 @@ var DoculaBuilder = class {
     const isMdx = documentPath.endsWith(".mdx");
     const fileExtension = isMdx ? ".mdx" : ".md";
     const documentsFolderIndex = documentPath.lastIndexOf("/docs/");
-    let urlPath = documentPath.slice(documentsFolderIndex).replace(fileExtension, "/index.html");
-    let isRoot = urlPath.split("/").length === 3;
-    if (!documentPath.slice(documentsFolderIndex + 6).includes("/")) {
-      isRoot = true;
-      const filePath = documentPath.slice(documentsFolderIndex + 6);
-      if (filePath === "index.md" || filePath === "index.mdx") {
-        urlPath = documentPath.slice(documentsFolderIndex).replace(fileExtension, ".html");
+    const relativePath = documentPath.slice(documentsFolderIndex + 6);
+    const docsPrefix = this.options.docsPath ? `/${this.options.docsPath}` : "";
+    let urlPath = `${docsPrefix}/${relativePath}`.replace(
+      fileExtension,
+      "/index.html"
+    );
+    const isRoot = !relativePath.includes("/");
+    if (isRoot) {
+      if (relativePath === "index.md" || relativePath === "index.mdx") {
+        urlPath = `${docsPrefix}/${relativePath}`.replace(
+          fileExtension,
+          ".html"
+        );
       }
     }
     if (!this.hasTableOfContents(markdownContent)) {
@@ -2801,7 +2965,11 @@ ${entry}
       openApiUrl: this.options.openApiUrl,
       themeMode: this.options.themeMode,
       cookieAuth: this.options.cookieAuth,
-      headerLinks: this.options.headerLinks
+      headerLinks: this.options.headerLinks,
+      baseUrl: this.options.baseUrl,
+      docsPath: this.options.docsPath,
+      apiPath: this.options.apiPath,
+      changelogPath: this.options.changelogPath
     };
     return this._hash.toHashSync(JSON.stringify(relevant));
   }

package/package.json

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

package/templates/modern/api.hbs

@@ -3,7 +3,7 @@
 
 <head>
   {{> header }}
-  <link rel="stylesheet" href="/css/api.css">
+  <link rel="stylesheet" href="{{baseUrl}}/css/api.css">
   <title>API Reference - {{ siteTitle }}</title>
   <meta name="description" content="API Reference for {{ siteTitle }}" />
 </head>
@@ -250,7 +250,7 @@
   {{> footer }}
   {{> scripts }}
 
-  <script src="/js/api.js"></script>
+  <script src="{{baseUrl}}/js/api.js"></script>
 </body>
 
 </html>

package/templates/modern/changelog-entry.hbs

@@ -12,7 +12,7 @@
     <main class="versions-container">
       <div class="versions-content">
         <div class="changelog-entry-nav">
-          <a href="/changelog/">&larr; Back to Changelog</a>
+          <a href="{{changelogUrl}}/">&larr; Back to Changelog</a>
         </div>
         <div class="changelog-entry changelog-entry-single">
           <div class="changelog-entry-header">

package/templates/modern/changelog.hbs

@@ -16,7 +16,7 @@
         {{#each entries as |entry|}}
         <div class="changelog-entry">
           <div class="changelog-entry-header">
-            <a class="changelog-entry-title" href="/changelog/{{entry.slug}}/">{{entry.title}}</a>
+            <a class="changelog-entry-title" href="{{changelogUrl}}/{{entry.slug}}/">{{entry.title}}</a>
             {{#if entry.tag}}
             <span class="changelog-tag changelog-tag-{{entry.tagClass}}">{{entry.tag}}</span>
             {{/if}}

package/templates/modern/home.hbs

@@ -3,7 +3,7 @@
 
 <head>
   {{> header }}
-  <link rel="stylesheet" href="/css/home.css">
+  <link rel="stylesheet" href="{{baseUrl}}/css/home.css">
   <title>{{ siteTitle }}</title>
 </head>
 
@@ -24,7 +24,7 @@
 
   {{#if content}}
   <header class="home-hero">
-    <img src="/logo.svg" alt="logo" />
+    <img src="{{baseUrl}}/logo.svg" alt="logo" />
     {{#if announcement}}
     <div class="announcement">{{{announcement}}}</div>
     {{/if}}

package/templates/modern/includes/api-reference.hbs

@@ -1 +1 @@
-<a href="/api" class="home-docs-button">API Reference</a>
+<a href="{{apiUrl}}" class="home-docs-button">API Reference</a>

package/templates/modern/includes/documentation.hbs

@@ -1 +1 @@
-<a href="/docs" class="home-docs-button">Documentation</a>
+<a href="{{docsUrl}}" class="home-docs-button">Documentation</a>

package/templates/modern/includes/footer.hbs

@@ -1,9 +1,9 @@
 <footer>
   {{#if enableLlmsTxt}}
-  <a href="/llms.txt" class="footer__link">llms.txt</a>
+  <a href="{{baseUrl}}/llms.txt" class="footer__link">llms.txt</a>
   {{/if}}
   {{#if hasFeed}}
-  <a href="/feed.xml" class="footer__link" aria-label="RSS Feed">
+  <a href="{{baseUrl}}/feed.xml" class="footer__link" aria-label="RSS Feed">
     <svg class="footer__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor"><circle cx="6.18" cy="17.82" r="2.18"/><path d="M4 4.44v2.83c7.03 0 12.73 5.7 12.73 12.73h2.83c0-8.59-6.97-15.56-15.56-15.56zm0 5.66v2.83c3.9 0 7.07 3.17 7.07 7.07h2.83c0-5.47-4.43-9.9-9.9-9.9z"/></svg>
   </a>
   {{/if}}

package/templates/modern/includes/header-bar.hbs

@@ -4,24 +4,24 @@
       <button class="mobile-menu-toggle" id="mobile-menu-toggle" aria-label="Toggle navigation menu">
         <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="4" x2="20" y1="12" y2="12"/><line x1="4" x2="20" y1="6" y2="6"/><line x1="4" x2="20" y1="18" y2="18"/></svg>
       </button>
-      <a href="/">
-        <img alt="{{siteTitle}}" class="logo__img" src="/logo.svg">
+      <a href="{{baseUrl}}/">
+        <img alt="{{siteTitle}}" class="logo__img" src="{{baseUrl}}/logo.svg">
       </a>
       <nav class="header-bottom__nav">
         {{#if hasDocuments}}
-        <a class="header-bottom__item" href="/docs/" id="nav-docs">
+        <a class="header-bottom__item" href="{{docsUrl}}/" id="nav-docs">
           <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
           <span>Documentation</span>
         </a>
         {{/if}}
         {{#if openApiUrl}}
-        <a class="header-bottom__item" href="/api" id="nav-api">
+        <a class="header-bottom__item" href="{{apiUrl}}" id="nav-api">
           <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
           <span>API Reference</span>
         </a>
         {{/if}}
         {{#if hasChangelog}}
-        <a class="header-bottom__item" href="/changelog" id="nav-changelog">
+        <a class="header-bottom__item" href="{{changelogUrl}}" id="nav-changelog">
           <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
           <span>Changelog</span>
         </a>
@@ -68,19 +68,19 @@
 <aside class="mobile-sidebar" id="mobile-sidebar">
   <nav class="mobile-nav">
     {{#if hasDocuments}}
-    <a class="mobile-nav__item" href="/docs/">
+    <a class="mobile-nav__item" href="{{docsUrl}}/">
       <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 7v14"/><path d="M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"/></svg>
       <span>Documentation</span>
     </a>
     {{/if}}
     {{#if openApiUrl}}
-    <a class="mobile-nav__item" href="/api">
+    <a class="mobile-nav__item" href="{{apiUrl}}">
       <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m16 18 6-6-6-6"/><path d="m8 6-6 6 6 6"/></svg>
       <span>API Reference</span>
     </a>
     {{/if}}
     {{#if hasChangelog}}
-    <a class="mobile-nav__item" href="/changelog">
+    <a class="mobile-nav__item" href="{{changelogUrl}}">
       <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M11 6a13 13 0 0 0 8.4-2.8A1 1 0 0 1 21 4v12a1 1 0 0 1-1.6.8A13 13 0 0 0 11 14H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2z"/><path d="M6 14a12 12 0 0 0 2.4 7.2 2 2 0 0 0 3.2-2.4A8 8 0 0 1 10 14"/><path d="M8 6v8"/></svg>
       <span>Changelog</span>
     </a>

package/templates/modern/includes/header.hbs

@@ -1,10 +1,10 @@
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="description" content="{{siteDescription}}">
-<link rel="stylesheet" href="/css/variables.css">
-<link rel="stylesheet" href="/css/styles.css">
-<link rel="stylesheet" href="/css/highlight/styles/base16/docula.css">
-<link rel="icon" href="/favicon.ico">
+<link rel="stylesheet" href="{{baseUrl}}/css/variables.css">
+<link rel="stylesheet" href="{{baseUrl}}/css/styles.css">
+<link rel="stylesheet" href="{{baseUrl}}/css/highlight/styles/base16/docula.css">
+<link rel="icon" href="{{baseUrl}}/favicon.ico">
 <script>
   (function(){
     window.__doculaThemeKey = 'docula:theme:' + ({{#if siteUrl}}'{{siteUrl}}'{{else}}location.origin{{/if}}).replace(/^https?:\/\//, '');

package/templates/modern/includes/home.hbs

@@ -34,7 +34,7 @@
 
     {{#if (gt github.releases.length 6)}}
     <div>
-      <a class="release-btn" href="/changelog">
+      <a class="release-btn" href="{{changelogUrl}}">
         Full Changelog
         <span>&rarr;</span>
       </a>

package/templates/modern/includes/scripts.hbs

@@ -1,4 +1,4 @@
-<script src="/css/highlight/highlight.min.js"></script>
+<script src="{{baseUrl}}/css/highlight/highlight.min.js"></script>
 <script>
   document.addEventListener('DOMContentLoaded', () => {
     document.querySelectorAll('pre code').forEach(el => { el.textContent = el.textContent.trimEnd(); });