docula 1.0.0 → 1.1.0

package/dist/docula.d.ts

@@ -75,6 +75,11 @@ type DoculaCookieAuth = {
     cookieName?: string;
     logoutUrl?: string;
 };
+type DoculaHeaderLink = {
+    label: string;
+    url: string;
+    icon?: string;
+};
 type DoculaCacheOptions = {
     github: {
         ttl: number;
@@ -161,6 +166,11 @@ declare class DoculaOptions {
      * in the header based on whether a JWT cookie is present.
      */
     cookieAuth?: DoculaCookieAuth;
+    /**
+     * Additional links to display in the site header navigation.
+     * Each link requires a label and url.
+     */
+    headerLinks?: DoculaHeaderLink[];
     /**
      * File extensions to copy as assets from docs/ and changelog/ directories.
      * Override in docula.config to customize.
@@ -217,6 +227,11 @@ type DoculaData = {
         cookieName?: string;
         logoutUrl?: string;
     };
+    headerLinks?: Array<{
+        label: string;
+        url: string;
+        icon?: string;
+    }>;
 };
 type DoculaTemplates = {
     home: string;
@@ -392,4 +407,4 @@ declare class Docula {
     serve(options: DoculaOptions): Promise<http.Server>;
 }
 
-export { type DoculaCacheOptions, type DoculaCookieAuth, DoculaOptions, Docula as default };
+export { type DoculaCacheOptions, type DoculaCookieAuth, type DoculaHeaderLink, DoculaOptions, Docula as default };

package/dist/docula.js

@@ -920,6 +920,11 @@ var DoculaOptions = class {
    * in the header based on whether a JWT cookie is present.
    */
   cookieAuth;
+  /**
+   * Additional links to display in the site header navigation.
+   * Each link requires a label and url.
+   */
+  headerLinks;
   /**
    * File extensions to copy as assets from docs/ and changelog/ directories.
    * Override in docula.config to customize.
@@ -1027,6 +1032,14 @@ var DoculaOptions = class {
     if (options.cookieAuth && typeof options.cookieAuth === "object" && typeof options.cookieAuth.loginUrl === "string") {
       this.cookieAuth = options.cookieAuth;
     }
+    if (options.headerLinks && Array.isArray(options.headerLinks)) {
+      const validLinks = options.headerLinks.filter(
+        (link) => typeof link === "object" && link !== null && typeof link.label === "string" && typeof link.url === "string"
+      );
+      if (validLinks.length > 0) {
+        this.headerLinks = validLinks;
+      }
+    }
   }
 };
 
@@ -1094,7 +1107,8 @@ var DoculaBuilder = class {
       openApiUrl: this.options.openApiUrl,
       homePage: this.options.homePage,
       themeMode: this.options.themeMode,
-      cookieAuth: this.options.cookieAuth
+      cookieAuth: this.options.cookieAuth,
+      headerLinks: this.options.headerLinks
     };
     if (!doculaData.openApiUrl && fs3.existsSync(`${doculaData.sitePath}/api/swagger.json`)) {
       doculaData.openApiUrl = "/api/swagger.json";
@@ -2649,6 +2663,7 @@ export {
 };
 /* v8 ignore next -- @preserve */
 /* v8 ignore next 3 -- @preserve */
+/* v8 ignore next 5 -- @preserve */
 /* v8 ignore next 2 -- @preserve */
 /* v8 ignore next 9 -- @preserve */
 /* v8 ignore next 4 -- @preserve */

package/package.json

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

package/templates/classic/css/multipage.css

@@ -127,6 +127,32 @@
   align-items: center;
 }
 
+.sidebar-links {
+  display: none;
+}
+
+@media screen and (min-width: 992px) {
+  .sidebar-links {
+    display: flex;
+    flex-direction: column;
+    gap: 0.5rem;
+    padding: 1rem 0;
+    border-top: 1px solid var(--border);
+    margin-top: 1rem;
+  }
+
+  .sidebar-header-link {
+    color: var(--sidebar-text);
+    text-decoration: none;
+    font-size: 0.875rem;
+    padding: 0.25rem 0;
+  }
+
+  .sidebar-header-link:hover {
+    text-decoration: underline;
+  }
+}
+
 .header-logo {
   flex-shrink: 0;
   margin-right: 1.5rem;

package/templates/classic/includes/multipage/header.hbs

@@ -5,6 +5,11 @@
         <a class="header-logo" href="/">
           <img src="/logo.svg" alt="logo" />
         </a>
+        {{#if headerLinks}}
+        {{#each headerLinks}}
+        <a class="header-link" href="{{this.url}}" target="_blank" rel="noopener noreferrer">{{#if this.icon}}{{{this.icon}}} {{/if}}{{this.label}}</a>
+        {{/each}}
+        {{/if}}
         <button id="open-sidebar" class="icon menu-btn">
           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg>
           <span>Menu</span>

package/templates/classic/includes/multipage/sidebar.hbs

@@ -36,6 +36,13 @@
         {{/forEach}}
       </ul>
 
+      {{#if headerLinks}}
+      <div class="sidebar-links">
+        {{#each headerLinks}}
+        <a class="sidebar-header-link" href="{{this.url}}" target="_blank" rel="noopener noreferrer">{{#if this.icon}}{{{this.icon}}} {{/if}}{{this.label}}</a>
+        {{/each}}
+      </div>
+      {{/if}}
     </div>
   </section>
 

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

@@ -26,6 +26,18 @@
           <span>Changelog</span>
         </a>
         {{/if}}
+        {{#if headerLinks}}
+        {{#each headerLinks}}
+        <a class="header-bottom__item" href="{{this.url}}" target="_blank" rel="noopener noreferrer">
+          {{#if this.icon}}
+          {{{this.icon}}}
+          {{else}}
+          <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="M15 3h6v6"/><path d="M10 14 21 3"/><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/></svg>
+          {{/if}}
+          <span>{{this.label}}</span>
+        </a>
+        {{/each}}
+        {{/if}}
       </nav>
       {{#if cookieAuth}}
       <a href="{{cookieAuth.loginUrl}}" class="cookie-auth-btn" id="cookie-auth-login">
@@ -61,6 +73,18 @@
       <span>Changelog</span>
     </a>
     {{/if}}
+    {{#if headerLinks}}
+    {{#each headerLinks}}
+    <a class="mobile-nav__item" href="{{this.url}}" target="_blank" rel="noopener noreferrer">
+      {{#if this.icon}}
+      {{{this.icon}}}
+      {{else}}
+      <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="M15 3h6v6"/><path d="M10 14 21 3"/><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/></svg>
+      {{/if}}
+      <span>{{this.label}}</span>
+    </a>
+    {{/each}}
+    {{/if}}
     {{#if cookieAuth}}
     <a class="mobile-nav__item" href="{{cookieAuth.loginUrl}}" id="cookie-auth-login-mobile">
       <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="M15 3h4a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2h-4"/><polyline points="10 17 15 12 10 7"/><line x1="15" x2="3" y1="12" y2="12"/></svg>