lowkey-doc 1.1.2 → 1.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lowkey-doc",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Render a folder of Markdown into one self-contained documentation dashboard, with flowcharts and ER diagrams that stay readable when they get dense.",
   "repository": {
     "type": "git",

package/src/build.mjs

@@ -81,8 +81,8 @@ export function collectDocs(cfg, memo = null) {
   return { docs, changed, memo: { layout, files } };
 }
 
-// ELK travels even when the default engine is mermaid: the reader can switch
-// any single diagram over from the page, and that has to work offline too.
+// ELK travels even when the default engine is mermaid, so a config edit under
+// --watch can turn the clean layout on without fetching anything.
 export async function vendorAssets(cfg, refresh = false) {
   fs.mkdirSync(cfg.outDir, { recursive: true });
   // The default output folder keeps itself out of git, so no project has to

package/src/client/app.mjs

@@ -469,7 +469,7 @@ export const APP_JS = String.raw`
     // left alone here.
     var fig = e.target.closest('.diagram');
     if (fig && !e.target.closest('svg.dg') && !e.target.closest('.diagram-head')){
-      var svg = fig.querySelector('svg');
+      var svg = fig.querySelector('.diagram-out > svg');
       if (svg) openBox(svg);
       return;
     }
@@ -1189,13 +1189,12 @@ export const APP_JS = String.raw`
 
     // Edited diagrams, when they line up one for one with the ones they
     // replace: the old drawing stays up, faded, until the new one is ready -
-    // no collapse and regrow under the reader - and a layout switched, or an
-    // entity opened, from the page stays that way.
+    // no collapse and regrow under the reader - and an entity opened from the
+    // page stays open.
     var stale = olds.filter(function(f){ return !used.has(f); });
     if (stale.length !== fresh.length) return;
     fresh.forEach(function(f, i){
       var o = stale[i];
-      if (o.dataset.engine) f.dataset.engine = o.dataset.engine;
       if (o._open) f._open = o._open;
       var out = f.querySelector('.diagram-out'), prev = o.querySelector('.diagram-out');
       if (!out || !prev || !prev.firstChild) return;

package/src/client/css.mjs

@@ -614,18 +614,24 @@ export const CSS_DIAGRAM = `
 .diagram-name{flex:1;min-width:0;display:flex;align-items:baseline;gap:9px;overflow:hidden;white-space:nowrap}
 .diagram-kind{flex:none;font-size:10px;font-weight:var(--bold);letter-spacing:.09em;text-transform:uppercase;color:var(--faint)}
 .diagram-title{min-width:0;overflow:hidden;text-overflow:ellipsis;font-size:12.5px;font-weight:var(--semi);color:var(--ink)}
-.diagram-bar{flex:none;display:flex;gap:5px}
-.diagram-btn{padding:3px 11px;font:inherit;font-size:11px;color:var(--muted);
-  background:transparent;border:1px solid var(--line-2);border-radius:999px;cursor:pointer;
-  transition:color .12s,border-color .12s}
-.diagram-btn:hover{color:var(--ink);border-color:rgba(255,255,255,.32)}
-.diagram-btn:empty{display:none}
-.diagram:has(svg):hover{border-color:var(--line-2)}
+.diagram-head{cursor:pointer;transition:background .12s}
+.diagram-head:hover{background:var(--surface-2)}
+.diagram-bar{flex:none;display:flex;gap:2px}
+.diagram-btn{width:26px;height:26px;padding:0;display:grid;place-items:center;
+  background:none;border:1px solid transparent;border-radius:999px;color:var(--faint);cursor:pointer;
+  transition:background .15s,color .15s,border-color .15s}
+.diagram-btn svg{width:14px;height:14px}
+.diagram-btn[data-act=fold] svg{transition:transform .18s ease}
+.diagram-head:hover .diagram-btn[data-act=fold],.diagram-btn:hover{color:var(--ink)}
+.diagram-btn:hover{background:var(--hover);border-color:var(--line)}
+.diagram:has(.diagram-out > svg):hover{border-color:var(--line-2)}
 .diagram .fail{font-family:var(--mono);font-size:12px;color:var(--muted);text-align:left;white-space:pre-wrap}
 .diagram-note{margin-top:10px;font-size:11px;color:var(--faint);text-align:center}
 /* A collapsed diagram is its header and nothing else: a plain white box the
-   height of a line, which a click opens again. */
+   height of a line, which a click opens again. Its chevron turns to point at
+   the header, as a closed dropdown's does. */
 .diagram.is-folded{padding-bottom:0;overflow:hidden;cursor:pointer}
+.diagram.is-folded .diagram-btn[data-act=fold] svg{transform:rotate(-90deg)}
 .diagram.is-folded .diagram-head{margin-bottom:0;border-bottom-color:transparent}
 .diagram.is-folded:hover{border-color:var(--line-2)}
 .diagram.is-folded .diagram-out,.diagram.is-folded .diagram-note,

package/src/client/diagrams.mjs

@@ -2180,19 +2180,11 @@ export const DIAGRAMS_JS = String.raw`
     });
   }
 
-  // The button is for comparing one diagram, not for changing the project's
-  // mind: a switch lasts as long as the page is open and no longer. The
-  // project-wide default is a config setting, where it can be reviewed.
-  function engineFor(fig, code){
+  // The engine is the project's choice, made in the config: the page does not
+  // offer the reader another one.
+  function engineFor(code){
     if (!cleanKind(code)) return 'mermaid';
-    return fig.dataset.engine || CFG.engine || 'clean';
-  }
-
-  function paintButton(fig, code, used){
-    var btn = fig.querySelector('[data-act="engine"]');
-    if (!btn) return;
-    btn.textContent = (cleanKind(code) && canClean(cleanKind(code)))
-      ? (used === 'clean' ? 'Mermaid layout' : 'Clean layout') : '';
+    return CFG.engine || 'clean';
   }
 
   /* ------------------------------------------------------------- folding
@@ -2224,8 +2216,9 @@ export const DIAGRAMS_JS = String.raw`
     fig.classList.toggle('is-folded', on);
     var btn = fig.querySelector('[data-act="fold"]');
     if (btn){
-      btn.textContent = on ? 'Show' : 'Collapse';
-      btn.title = on ? 'Show the diagram' : 'Fold the diagram away';
+      btn.title = on ? 'Show' : 'Collapse';
+      btn.setAttribute('aria-label', btn.title);
+      btn.setAttribute('aria-expanded', on ? 'false' : 'true');
     }
   }
 
@@ -2233,7 +2226,7 @@ export const DIAGRAMS_JS = String.raw`
     var code = fig.querySelector('.diagram-src').textContent;
     if (!fig._foldSeen){ fig._foldSeen = true; paintFold(fig, folded(fig)); }
     if (fig.classList.contains('is-folded')) return Promise.resolve();
-    var want = force || engineFor(fig, code);
+    var want = force || engineFor(code);
     if (fig.dataset.drawn === want) return Promise.resolve();
     fig.dataset.drawn = want;
     var kind = cleanKind(code);
@@ -2251,7 +2244,7 @@ export const DIAGRAMS_JS = String.raw`
       if (note) note.remove();
       done = renderMermaid(fig, code);
     }
-    return done.then(function(){ paintButton(fig, code, fig.dataset.drawn); });
+    return done;
   }
 
   function drawAll(scope){
@@ -2545,6 +2538,14 @@ export const DIAGRAMS_JS = String.raw`
     var shut = e.target.closest && e.target.closest('.diagram.is-folded');
     // anywhere on a collapsed diagram opens it
     if (shut && (!btn || btn.dataset.act === 'fold')){ e.stopPropagation(); setFold(shut, false); return; }
+    // the header bar folds the diagram as its chevron does - unless the click
+    // was really the end of a drag that selected some of the title
+    var head = !btn && e.target.closest && e.target.closest('.diagram-head');
+    if (head){
+      var s = window.getSelection();
+      if (s && !s.isCollapsed && String(s).trim()) return;
+      btn = head.querySelector('[data-act="fold"]');
+    }
     if (!btn) return;
     var fig = btn.closest('.diagram');
     if (!fig) return;
@@ -2555,14 +2556,8 @@ export const DIAGRAMS_JS = String.raw`
       setFold(fig, true);
       return;
     }
-    if (btn.dataset.act === 'engine'){
-      var next = fig.dataset.drawn === 'clean' ? 'mermaid' : 'clean';
-      fig.dataset.engine = next;
-      draw(fig, next);
-      return;
-    }
     if (btn.dataset.act === 'zoom'){
-      var svg = fig.querySelector('svg');
+      var svg = fig.querySelector('.diagram-out > svg');
       if (svg && window.__lightbox) window.__lightbox(svg);
     }
   }, true);

package/src/markdown.mjs

@@ -25,6 +25,11 @@ const DIAGRAM_KINDS = {
   gantt: 'Gantt chart', pie: 'Pie chart', journey: 'User journey', mindmap: 'Mind map',
   timeline: 'Timeline', gitgraph: 'Git graph', quadrantchart: 'Quadrant chart',
 };
+const SVG_OPEN = '<svg viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.6" ' +
+  'stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">';
+const FULL_SVG = SVG_OPEN + '<path d="M3 6.5V3h3.5M9.5 3H13v3.5M13 9.5V13H9.5M6.5 13H3V9.5"/></svg>';
+const FOLD_SVG = SVG_OPEN + '<path d="M3.5 6L8 10.5 12.5 6"/></svg>';
+
 function diagramName(code) {
   let title = '';
   const body = String(code).replace(/^\s*---\r?\n([\s\S]*?)\r?\n---[ \t]*(\r?\n|$)/, (_, fm) => {
@@ -521,9 +526,8 @@ export function parkFences(md, ctx) {
         ? '<figure class="diagram" data-diagram><pre class="diagram-src">' + esc(code) + '</pre>' +
           '<div class="diagram-head">' + diagramName(code) +
             '<div class="diagram-bar">' +
-              '<button class="diagram-btn" data-act="fold" type="button" title="Fold the diagram away">Collapse</button>' +
-              '<button class="diagram-btn" data-act="zoom" type="button" title="Open full size">Expand</button>' +
-              '<button class="diagram-btn" data-act="engine" type="button" title="Switch layout engine"></button>' +
+              '<button class="diagram-btn" data-act="zoom" type="button" title="Open full size" aria-label="Open full size">' + FULL_SVG + '</button>' +
+              '<button class="diagram-btn" data-act="fold" type="button" title="Collapse" aria-label="Collapse" aria-expanded="true">' + FOLD_SVG + '</button>' +
             '</div>' +
           '</div>' +
           '<div class="diagram-out"></div></figure>'