@docmd/ui 0.4.4 → 0.4.6

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 docmd (docmd.io)
+Copyright (c) 2025 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

@@ -5,4 +5,29 @@ The visual foundation of **docmd**.
 Contains:
 - **Templates:** EJS layout files (`layout.ejs`, `no-style.ejs`).
 - **Assets:** Core CSS and JavaScript.
-- **Icons:** SVG icon sets.
+- **Icons:** SVG icon sets.
+
+## The docmd Ecosystem
+
+`docmd` is a modular system. Here are the official packages:
+
+**The Engine**
+*   [**@docmd/core**](https://www.npmjs.com/package/@docmd/core) - The CLI runner and build orchestrator.
+*   [**@docmd/parser**](https://www.npmjs.com/package/@docmd/parser) - The pure Markdown-to-HTML logic.
+*   [**@docmd/live**](https://www.npmjs.com/package/@docmd/live) - The browser-based Live Editor bundle.
+
+**Interface & Design**
+*   [**@docmd/ui**](https://www.npmjs.com/package/@docmd/ui) - Base EJS templates and assets.
+*   [**@docmd/themes**](https://www.npmjs.com/package/@docmd/themes) - Official themes (Sky, Ruby, Retro).
+
+**Plugins**
+*   [**@docmd/plugin-search**](https://www.npmjs.com/package/@docmd/plugin-search) - Offline full-text search.
+*   [**@docmd/plugin-mermaid**](https://www.npmjs.com/package/@docmd/plugin-mermaid) - Diagrams and flowcharts.
+*   [**@docmd/plugin-seo**](https://www.npmjs.com/package/@docmd/plugin-seo) - Meta tags and Open Graph data.
+*   [**@docmd/plugin-sitemap**](https://www.npmjs.com/package/@docmd/plugin-sitemap) - Automatic sitemap generation.
+*   [**@docmd/plugin-llms**](https://www.npmjs.com/package/@docmd/plugin-llms) - AI context generation.
+*   [**@docmd/plugin-analytics**](https://www.npmjs.com/package/@docmd/plugin-analytics) - Google Analytics integration.
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.

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

@@ -1,6 +1,18 @@
-/* Source file from the docmd project — https://github.com/docmd-io/docmd */
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
-pre code.hljs {
+ pre code.hljs {
     display: block;
     overflow-x: auto;
     padding: 1em

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

@@ -1,6 +1,18 @@
-/* Source file from the docmd project — https://github.com/docmd-io/docmd */
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
-pre code.hljs {
+ pre code.hljs {
     display: block;
     overflow-x: auto;
     padding: 1em

package/assets/css/docmd-main.css

@@ -1,4 +1,16 @@
-/* Source file from the docmd project — https://github.com/docmd-io/docmd */
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
 /*
  * docmd-main.css
@@ -100,6 +112,20 @@ a:any-link {
     color: var(--link-color)
 }
 
+.skip-link {
+    position: absolute;
+    top: -100px;
+    left: 0;
+    background: var(--bg-color);
+    color: var(--link-color);
+    padding: 8px;
+    z-index: 9999;
+}
+
+.skip-link:focus {
+    top: 0;
+}
+
 .sidebar {
     scrollbar-gutter: stable;
     display: flex;
@@ -411,7 +437,8 @@ pre {
     padding: 1.25em;
     color: var(--code-text);
     overflow-x: auto;
-    position: relative
+    position: relative;
+    white-space: pre;
 }
 
 code {

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

@@ -1,4 +1,16 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
 /* 
  * A simple lightbox implementation for gallery images

package/assets/js/docmd-main.js

@@ -1,4 +1,16 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
 /* 
  * Main client-side script for docmd UI interactions

package/index.js

@@ -1,3 +1,17 @@
+/**
+ * --------------------------------------------------------------------
+ * 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 = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docmd/ui",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "Base UI templates and assets for docmd",
   "main": "index.js",
   "files": [

package/templates/layout.ejs

@@ -1,8 +1,16 @@
-<%# packages/ui/templates/layout.ejs %>
+<!--
+  ---------------------------------------------------------------
+  docmd : the minimalist, zero-config documentation generator.
+  @website https://docmd.io
+  [docmd-source] - Please do not remove this header.
+  ---------------------------------------------------------------
+-->
+
 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
+    <meta name="generator" content="docmd v0.4.x">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <!-- Define Globals -->
@@ -52,7 +60,7 @@
 <body class="<%= sidebarConfig.collapsible ? 'sidebar-collapsible' : 'sidebar-not-collapsible' %>" 
       data-default-collapsed="<%= sidebarConfig.defaultCollapsed %>" 
       data-copy-code-enabled="<%= config.copyCode === true %>">
-
+    <a href="#main-content" class="skip-link">Skip to main content</a>
     <aside class="sidebar">
         <div class="sidebar-header">
             <% if (logo && logo.light && logo.dark) { %>
@@ -116,7 +124,7 @@
             <% } %>
         </div>
 
-        <main class="content-area">
+        <main class="content-area" id="main-content">
             <div class="content-layout">
                 <div class="main-content">
                     <%- content %>
@@ -183,13 +191,16 @@
     </div>
     <% } %>
 
-    <!-- Plugin Scripts -->
+    <!-- CORE JS -->
+    <script src="<%= relativePathToRoot %>assets/js/docmd-main.js?v=<%= buildHash %>"></script>
+
+    <!-- PLUGINS -->
     <%- pluginBodyScriptsHtml || '' %>
 
-    <!-- User Custom JS (Sanitized) -->
+    <!-- CUSTOM JS -->
     <% (customJsFiles || []).forEach(jsFile => { 
        if (jsFile && jsFile.trim() !== '') { %>
-    <script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>"></script>
+    <script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>?v=<%= buildHash %>"></script>
     <% } }); %>
 </body>
 </html>

package/templates/navigation.ejs

@@ -1,6 +1,11 @@
-<%# packages/ui/templates/navigation.ejs %>
+<%# ---------------------------------------------------------------
+  # docmd : the minimalist, zero-config documentation generator.
+  # @website https://docmd.io
+  # [docmd-source] - Please do not remove this header.
+  # ---------------------------------------------------------------
+%>
 
-<nav class="sidebar-nav" aria-label="Main navigation">
+<nav class="sidebar-nav" aria-label="Main Navigation">
   <ul>
     <%
       function normalizePath(p) {

package/templates/no-style.ejs

@@ -1,9 +1,16 @@
-<%# Source file from the docmd project — https://github.com/docmd-io/docmd %>
+<!--
+  ---------------------------------------------------------------
+  docmd : the minimalist, zero-config documentation generator.
+  @website https://docmd.io
+  [docmd-source] - Please do not remove this header.
+  ---------------------------------------------------------------
+-->
 
 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="UTF-8">
+    <meta name="generator" content="docmd v0.4.x">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <!-- 1. GLOBALS -->

package/templates/partials/theme-init.js

@@ -1,4 +1,16 @@
-/* packages/ui/templates/partials/theme-init.js */
+/**
+ * --------------------------------------------------------------------
+ * 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.
+ * --------------------------------------------------------------------
+ */
 
 (function() {
   try {

package/templates/toc.ejs

@@ -1,4 +1,9 @@
-<%# Source file from the docmd project — https://github.com/docmd-io/docmd %>
+<%# ---------------------------------------------------------------
+  # docmd : the minimalist, zero-config documentation generator.
+  # @website https://docmd.io
+  # [docmd-source] - Please do not remove this header.
+  # ---------------------------------------------------------------
+%>
 
 <% 
 function decodeHtmlEntities(html) {