@docmd/ui 0.5.4 → 0.6.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 docmd.io
+Copyright (c) 2025-present docmd.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -21,6 +21,7 @@ Contains:
 *   [**@docmd/themes**](https://www.npmjs.com/package/@docmd/themes) - Official themes (Sky, Ruby, Retro).
 
 **Plugins**
+*   [**@docmd/plugin-installer**](https://www.npmjs.com/package/@docmd/plugin-installer) - Plugin installer for docmd.
 *   [**@docmd/plugin-search**](https://www.npmjs.com/package/@docmd/plugin-search) - Offline full-text search.
 *   [**@docmd/plugin-pwa**](https://www.npmjs.com/package/@docmd/plugin-pwa) - Progressive Web App support.
 *   [**@docmd/plugin-mermaid**](https://www.npmjs.com/package/@docmd/plugin-mermaid) - Diagrams and flowcharts.

package/assets/css/docmd-highlight-dark.css

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/assets/css/docmd-highlight-light.css

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/assets/css/docmd-main.css

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/assets/js/docmd-image-lightbox.js

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/assets/js/docmd-main.js

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * --------------------------------------------------------------------
+ * docmd : the minimalist, zero-config documentation generator.
+ *
+ * @package     @docmd/core (and ecosystem)
+ * @website     https://docmd.io
+ * @repository  https://github.com/docmd-io/docmd
+ * @license     MIT
+ * @copyright   Copyright (c) 2025-present docmd.io
+ *
+ * [docmd-source] - Please do not remove this header.
+ * --------------------------------------------------------------------
+ */
+export declare function getTemplatesDir(): string;
+export declare function getAssetsDir(): string;
+export declare function getTemplatePath(name: string): string;

package/dist/index.js

@@ -0,0 +1,28 @@
+/**
+ * --------------------------------------------------------------------
+ * docmd : the minimalist, zero-config documentation generator.
+ *
+ * @package     @docmd/core (and ecosystem)
+ * @website     https://docmd.io
+ * @repository  https://github.com/docmd-io/docmd
+ * @license     MIT
+ * @copyright   Copyright (c) 2025-present docmd.io
+ *
+ * [docmd-source] - Please do not remove this header.
+ * --------------------------------------------------------------------
+ */
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export function getTemplatesDir() {
+    return path.join(__dirname, '..', 'templates');
+}
+export function getAssetsDir() {
+    return path.join(__dirname, '..', 'assets');
+}
+// Helper to resolve template paths
+export function getTemplatePath(name) {
+    const fileName = name.endsWith('.ejs') ? name : `${name}.ejs`;
+    return path.join(__dirname, '..', 'templates', fileName);
+}

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "@docmd/ui",
-  "version": "0.5.4",
+  "version": "0.6.1",
   "description": "Base UI templates and assets for docmd.",
-  "main": "index.js",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
   "files": [
+    "dist",
     "templates",
-    "assets",
-    "index.js"
+    "assets"
   ],
   "keywords": [
     "docmd",

package/templates/layout.ejs

@@ -65,7 +65,7 @@
   <a href="#main-content" class="skip-link">Skip to main content</a>
 
   <% if (locals.menubarConfig && menubarConfig?.enabled !==false && menubarConfig.position !=='header' ) { %>
-    <%- include('partials/menubar', { menubarConfig, relativePathToRoot, renderIcon, optionsMenu: locals.optionsMenu })
+    <%- await include('partials/menubar', { menubarConfig, relativePathToRoot, renderIcon, optionsMenu: locals.optionsMenu })
       %>
       <% } %>
 
@@ -96,12 +96,12 @@
             <div class="sidebar-top-group">
               <% if (locals.optionsMenu && optionsMenu.position==='sidebar-top' ) { %>
                 <div class="sidebar-options-wrapper">
-                  <%- include('partials/options-menu', { optionsMenu }) %>
+                  <%- await include('partials/options-menu', { optionsMenu }) %>
                 </div>
                 <% } %>
                   <% if (config.versions && config.versions.position==='sidebar-top' ) { %>
                     <div class="sidebar-version-wrapper">
-                      <%- include('partials/version-dropdown', { versions: config.versions, activeVersion:
+                      <%- await include('partials/version-dropdown', { versions: config.versions, activeVersion:
                         config._activeVersion, relativePathToRoot }) %>
                     </div>
                     <% } %>
@@ -112,13 +112,13 @@
               <div class="sidebar-bottom-group mt-auto">
                 <% if (config.versions && config.versions.position==='sidebar-bottom' ) { %>
                   <div class="sidebar-version-wrapper">
-                    <%- include('partials/version-dropdown', { versions: config.versions, activeVersion:
+                    <%- await include('partials/version-dropdown', { versions: config.versions, activeVersion:
                       config._activeVersion, relativePathToRoot }) %>
                   </div>
                   <% } %>
                     <% if (locals.optionsMenu && optionsMenu.position==='sidebar-bottom' ) { %>
                       <div class="sidebar-options-wrapper">
-                        <%- include('partials/options-menu', { optionsMenu }) %>
+                        <%- await include('partials/options-menu', { optionsMenu }) %>
                       </div>
                       <% } %>
               </div>
@@ -126,7 +126,7 @@
           <% } %>
             <div class="main-content-wrapper">
               <% if (locals.menubarConfig && menubarConfig?.enabled !==false && menubarConfig.position==='header' ) { %>
-                <%- include('partials/menubar', { menubarConfig, relativePathToRoot, renderIcon, optionsMenu:
+                <%- await include('partials/menubar', { menubarConfig, relativePathToRoot, renderIcon, optionsMenu:
                   locals.optionsMenu }) %>
                   <% } %>
                     <% if (headerConfig?.enabled !==false) { %>
@@ -145,7 +145,7 @@
 
                         <div class="header-right">
                           <% if (optionsMenu?.position==='header' ) { %>
-                            <%- include('partials/options-menu', { optionsMenu }) %>
+                            <%- await include('partials/options-menu', { optionsMenu }) %>
                               <% } %>
                         </div>
                       </header>
@@ -189,7 +189,7 @@
                                         <% } %>
                               </div>
                               <div class="toc-sidebar">
-                                <%- include('toc', { content, headings, navigationHtml, isActivePage }) %>
+                                <%- await include('toc', { content, headings, navigationHtml, isActivePage }) %>
                               </div>
                             </div>
                             <div class="page-footer-actions">
@@ -201,7 +201,7 @@
                                 <% } %>
                             </div>
                           </main>
-                          <%- include('partials/footer', { footerConfig, config, relativePathToRoot, logo, siteTitle,
+                          <%- await include('partials/footer', { footerConfig, config, relativePathToRoot, logo, siteTitle,
                             footerHtml }) %>
                         </div>
             </div>

package/templates/no-style.ejs

@@ -109,7 +109,7 @@
             <div class="main-content"><%- content %></div>
             <% if (frontmatter.components?.toc !==false && headings && headings.length> 0) { %>
               <div class="toc-sidebar">
-                <%- include('toc', { content, headings, navigationHtml, isActivePage }) %>
+                <%- await include('toc', { content, headings, navigationHtml, isActivePage }) %>
               </div>
             <% } %>
           </div>
@@ -172,7 +172,7 @@
             <div class="main-content"><%- content %></div>
             <% if (frontmatter.components?.toc !==false && headings && headings.length> 0) { %>
               <div class="toc-sidebar">
-                <%- include('toc', { content, headings, navigationHtml, isActivePage }) %>
+                <%- await include('toc', { content, headings, navigationHtml, isActivePage }) %>
               </div>
             <% } %>
           </div>

package/templates/partials/menubar.ejs

@@ -121,7 +121,7 @@
                 <% } %>
               <% if (optionsMenu && optionsMenu.position==='menubar' ) { %>
                 <div class="menubar-options">
-                  <%- include('options-menu', { optionsMenu }) %>
+                  <%- await include('options-menu', { optionsMenu }) %>
                 </div>
               <% } %>
       </div>

package/templates/partials/theme-init.js

@@ -6,7 +6,7 @@
  * @website     https://docmd.io
  * @repository  https://github.com/docmd-io/docmd
  * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
+ * @copyright   Copyright (c) 2025-present docmd.io
  *
  * [docmd-source] - Please do not remove this header.
  * --------------------------------------------------------------------

package/index.js

@@ -1,25 +0,0 @@
-/**
- * --------------------------------------------------------------------
- * docmd : the minimalist, zero-config documentation generator.
- *
- * @package     @docmd/core (and ecosystem)
- * @website     https://docmd.io
- * @repository  https://github.com/docmd-io/docmd
- * @license     MIT
- * @copyright   Copyright (c) 2025 docmd.io
- *
- * [docmd-source] - Please do not remove this header.
- * --------------------------------------------------------------------
- */
-
-const path = require('path');
-
-module.exports = {
-    getTemplatesDir: () => path.join(__dirname, 'templates'),
-    getAssetsDir: () => path.join(__dirname, 'assets'),
-    // Helper to resolve template paths
-    getTemplatePath: (name) => {
-        const fileName = name.endsWith('.ejs') ? name : `${name}.ejs`;
-        return path.join(__dirname, 'templates', fileName);
-    }
-};