@ui-doc/html-renderer 0.3.0 → 1.0.0

package/styles/03_components/navigation/main.css

@@ -0,0 +1,102 @@
+.nav-main {
+  --bg-color: var(--na-main-bg-color, var(--color-blue));
+  --font-color: var(--nav-main-bg-color, var(--color-white));
+  --accent-color: var(--nav-main-accent-color, var(--color-yellow));
+
+  position: sticky;
+  z-index: 100;
+  top: 0;
+}
+
+.nav-main > .bar,
+.nav-main > .bar > .menu {
+  display: flex;
+  gap: var(--nav-main-item-gap, calc(var(--space-unit) * var(--nav-main-item-gap-space, 0)));
+}
+
+.nav-main > .bar {
+  --width-content-offset: var(--nav-main-bar-item-space-x) * var(--space-unit);
+
+  container-name: nav-bar;
+  container-type: inline-size;
+  justify-content: center;
+  background: rgb(var(--bg-color));
+
+  > .logo,
+  > .burger.control,
+  > .menu > .control {
+    --space-px: var(--nav-main-bar-item-space-x);
+    --space-py: var(--nav-main-bar-item-space-y);
+  }
+
+  > .logo {
+    height: var(--nav-main-bar-item-height);
+
+    > svg {
+      width: auto;
+      height: 100%;
+    }
+  }
+
+  > .menu > .control {
+    --font-weight: var(--font-weight-bold);
+
+    display: block;
+
+    &[aria-current="page"] {
+      --font-color: var(--accent-color);
+    }
+  }
+
+  @container nav-bar (width > 1000px) {
+    > .burger.control {
+      display: none;
+    }
+
+    > .menu {
+      margin-left: auto;
+    }
+  }
+
+  @container nav-bar (width <= 1000px) {
+    position: relative;
+
+    > .burger.control {
+      --nav-burger-control-size: var(--nav-main-bar-item-height);
+
+      margin-left: auto;
+    }
+
+    > .menu {
+      position: absolute;
+      top: calc(var(--nav-main-bar-item-height));
+      left: 0;
+
+      overflow-y: auto;
+      flex-direction: column;
+
+      width: 100%;
+      max-height: calc(100vh - var(--nav-main-height));
+      padding: calc(var(--space-unit) * var(--nav-main-menu-space-t)) var(--width-calc)
+        calc(var(--space-unit) * var(--nav-main-menu-space-b));
+
+      opacity: 1;
+      background: rgb(var(--bg-color));
+    }
+
+    > .menu.menu-show-enter-active,
+    > .menu.menu-show-leave-active {
+      transition: opacity 0.3s ease-in-out;
+    }
+
+    > .menu.menu-show-enter-from,
+    > .menu.menu-show-leave-to {
+      opacity: 0;
+    }
+
+    > .menu[hidden],
+    > .burger.control[aria-expanded="false"] ~ .menu {
+      display: none;
+    }
+  }
+}

package/styles/03_components/spaces.css

@@ -4,7 +4,7 @@
 
   display: flex;
   flex-direction: column;
-  gap: var(--spaces-gap, var(--size-xs));
+  gap: var(--spaces-gap, calc(var(--spaces-gap-space, var(--space-xs)) * var(--space-unit)));
 }
 
 .spaces > .item {
@@ -15,20 +15,21 @@
     --font-color: var(--spaces-font-color);
   }
 
-  > div {
-    padding: var(--size-sm) var(--size-normal);
+  > .pxy {
+    --space-px: var(--space-normal);
+    --space-py: var(--space-xs);
   }
 
   > div:first-child {
-    margin-right: var(--space-value);
+    margin-right: calc(var(--space-value) * var(--space-unit));
   }
 
-  > div:last-child {
+  > .info {
     display: flex;
 
     > *:not(:last-child) {
-      margin-right: var(--size-xs);
-      padding-right: var(--size-xs);
+      margin-right: calc(var(--space-xs) * var(--space-unit));
+      padding-right: calc(var(--space-xs) * var(--space-unit));
       border-right: 1px solid currentcolor;
     }
 

package/styles/04_layout/body.css

@@ -0,0 +1,22 @@
+html {
+  height: 100%;
+}
+
+html > body:has(.expand-full-height) {
+  display: flex;
+  flex-direction: column;
+  min-height: 100%;
+
+  > .expand-full-height {
+    flex: 1 1;
+  }
+}
+
+html > body > footer {
+  --bg-color: var(--footer-bg-color, var(--color-blue));
+  --font-color: var(--footer-font-color, var(--color-white));
+
+  > .text {
+    text-align: right;
+  }
+}

package/styles/04_layout/inline-code.css

@@ -0,0 +1,6 @@
+p > code {
+  display: inline-block;
+  padding: 0.1em 0.2em;
+  color: rgb(var(--inline-code-font-color, var(--font-color)));
+  background: rgb(var(--inline-code-bg-color, var(--color-gray)));
+}

package/styles/04_layout/page.css

@@ -0,0 +1,73 @@
+body.page {
+  --main-sidebar-width: 25ch;
+  --main-content-sidebar-space: var(--space-xl);
+}
+
+body.page > .content {
+  --space-py: var(--space-xl);
+
+  .headline + .description {
+    margin-top: calc(var(--page-headline-description-space, var(--space-md)) * var(--space-unit));
+  }
+
+  > main > section + section {
+    margin-top: calc(var(--page-content-section-space, var(--space-xl)) * var(--space-unit));
+  }
+
+  > main * + .example,
+  > main *:not(.example) + .markup {
+    margin-top: 1em;
+  }
+}
+
+body.page > .content > main {
+  container-name: content;
+  container-type: inline-size;
+}
+
+@media screen and (width >= 1000px) {
+  body.page > .content:has(> .sidebar) {
+    display: grid;
+    grid-template-columns: var(--main-sidebar-width) 1fr;
+    grid-template-rows: auto 1fr;
+    gap: var(
+        --page-header-main-garp,
+        calc(var(--page-header-main-space, var(--space-lg)) * var(--space-unit))
+      )
+      var(
+        --page-content-sidebar-garp,
+        calc(var(--page-content-sidebar-space, var(--space-xl)) * var(--space-unit))
+      );
+
+    > .sidebar {
+      grid-column: 1 / span 1;
+      grid-row: 1 / span 2;
+    }
+
+    > header {
+      grid-column: 2 / span 1;
+      grid-row: 1 / span 1;
+    }
+
+    > main {
+      grid-column: 2 / span 1;
+      grid-row: 2 / span 1;
+    }
+
+    > .sidebar > .scrollbar {
+      position: sticky;
+      top: var(--nav-main-height);
+
+      overflow-y: auto;
+
+      height: 100%;
+      max-height: calc(100vh - var(--nav-main-height));
+    }
+  }
+}
+
+@media screen and (width < 1000px) {
+  body.page > .content > .sidebar {
+    display: none;
+  }
+}

package/styles/index.css

@@ -1,20 +1,61 @@
-@import url("./01_resets/root.css");
-@import url("./01_resets/initial.css");
-@import url("./01_resets/typography.css");
+/**
+  * Text for the index page
+  *
+  * @page index UI-Doc
+  */
 
-@import url("./02_objects/background.css");
-@import url("./02_objects/text.css");
-@import url("./02_objects/padding.css");
-@import url("./02_objects/margin.css");
-@import url("./02_objects/width.css");
-@import url("./02_objects/control.css");
+/**
+  * Variables used in the project.
+  *
+  * @page variables Variables
+  * @order 10
+  */
 
-@import url("./03_components/example-markup.css");
-@import url("./03_components/text-flow.css");
-@import url("./03_components/nav/main.css");
-@import url("./03_components/nav/list.css");
-@import url("./03_components/colors.css");
-@import url("./03_components/spaces.css");
-@import url("./03_components/icons.css");
+/**
+  * Resets used to normalize the browser styles.
+  *
+  * @page resets Resets
+  * @order 20
+  */
+@import url("01_resets/root.css");
+@import url("01_resets/initial.css");
+@import url("01_resets/typography.css");
 
-@import url("./04_layouts/page.css");
+/**
+  * Utility classes are building the base of all styles. They can be applyed everywhere to modify/control one specific thing.
+  *
+  * @page utils Utilities
+  * @order 30
+  */
+@import url("02_utils/background.css");
+@import url("02_utils/padding.css");
+@import url("02_utils/margin.css");
+@import url("02_utils/control.css");
+@import url("02_utils/width.css");
+
+/**
+  * Objects are build out of objects and define style for it's inner children.
+  *
+  * @page components Components
+  * @order 40
+  */
+@import url("03_components/button.css");
+@import url("03_components/container.css");
+@import url("03_components/grid-auto.css");
+@import url("03_components/navigation/burger-control.css");
+@import url("03_components/navigation/main.css");
+@import url("03_components/navigation/list.css");
+@import url("03_components/example-markup.css");
+@import url("03_components/colors.css");
+@import url("03_components/icons.css");
+@import url("03_components/spaces.css");
+
+/**
+  * Layouts are the outermost layer of the design. They define the structure of the page.
+  *
+  * @page layout Layout
+  * @order 50
+  */
+@import url("04_layout/body.css");
+@import url("04_layout/inline-code.css");
+@import url("04_layout/page.css");

package/templates/layouts/default.html

@@ -7,12 +7,10 @@
 
     {{var:styles}}
   </head>
-  <body class="{{var:page.id}}">
-    <header>{{partial:nav-main}}</header>
-    <main class="width-content">
-      {{page:page.id page}}
-    </main>
-    <footer class="width-content py mt">
+  <body class="page {{var:page.id}}">
+    {{partial:nav-main}}
+    {{page:page.id page}}
+    <footer class="width-content py bg">
       <div class="text">{{var:footerText}}</div>
     </footer>
 

package/templates/layouts/example.html

@@ -9,7 +9,7 @@
     <style>
       body {
         margin: 0 !important;
-        padding: 0 !important;
+        padding: 1em !important;
         overflow: hidden !important;
       }
       body > *:last-child {

package/templates/pages/default.html

@@ -1,14 +1,14 @@
-<div class="content">
-  <h1 class="headline">{{var:title}}</h1>
-
-  {{if:description}}<div class="description">{{var:description}}</div>{{/if}}
-
-  {{for:sections}}
-  {{partial:section}}
-  {{/for}}
+<div class="content width-content expand-full-height py">
+  <header class="container">
+    <h1 class="headline">{{var:title}}</h1>
+    {{if:description}}<div class="container description">{{var:description}}</div>{{/if}}
+  </header>
+  <main class="container">
+    {{for:sections}}
+    {{partial:section}}
+    {{/for}}
+  </main>
+  <aside class="sidebar">
+    <div class="scrollbar">{{partial:nav-sidebar}}</div>
+  </aside>
 </div>
-<aside class="sidebar">
-  <div class="scroll">{{partial:nav-sidebar}}</div>
-</aside>
-
-

package/templates/pages/index.html

@@ -1,3 +1,9 @@
-<h1 class="headline">{{var:title}}</h1>
-
-{{if:description}}<div class="description">{{var:description}}</div>{{/if}}
+<header class="width-content">
+  <h1 class="headline">{{var:title}}</h1>
+  {{if:description}}<div class="container description">{{var:description}}</div>{{/if}}
+</header>
+<main class="width-content expand-full-height">
+  {{for:sections}}
+  {{partial:section}}
+  {{/for}}
+</main>

package/templates/partials/code.html

@@ -1,5 +1,5 @@
 {{if:type}}
 <div class="markup">
-  <pre class="code"><code class="language-{{var:type}}">{{var:content escape}}</code></pre>
+  <pre class="code"><code class="pxy language-{{var:type}}">{{var:content escape}}</code></pre>
 </div>
 {{/if}}

package/templates/partials/colors.html

@@ -1,7 +1,7 @@
-<div class="colors">
+<div class="colors grid-auto">
   {{for:this}}
   <div
-    class="item bg"
+    class="item bg pxy"
     style="--bg-color: {{var:value.output}};{{if:font}} --font-color: {{var:font.output}};{{/if}}"
   >
     {{if:value.hex}}<span class="value">{{var:value.hex}}</span>{{/if}}

package/templates/partials/content.html

@@ -1,4 +1,4 @@
-<h{{var:titleLevel}} id="{{var:id}}">{{var:title}}</h{{var:titleLevel}}>
+<h{{var:titleLevel}} class="headline" id="{{var:id}}">{{var:title}}</h{{var:titleLevel}}>
 
 {{if:description}}{{var:description}}{{/if}}
 

package/templates/partials/icons.html

@@ -1,14 +1,14 @@
-<div class="icons">
+<div class="icons grid-auto">
   {{for:this}}
     {{if:value.name}}
-    <div class="item from-var" style="--icon: {{var:value.output}}">
+    <div class="item pxy from-var" style="--icon: {{var:value.output}}">
       <span class="show"></span>
       <span class="text">{{var:text}}</span>
       <span class="name">{{var:name}}</span>
     </div>
     {{/if}}
     {{if:value.value}}
-    <div class="item from-data">
+    <div class="item pxy from-data">
       <span class="show">{{var:value.output}}</span>
       <span class="text" data-icon="{{var:value.output}}">{{var:text}}</span>
       <span class="name">{{var:name}}</span>

package/templates/partials/nav-main.html

@@ -1,9 +1,20 @@
-<nav class="nav-main width-content" aria-label="Main navigation" role="menu">
-  <div class="bar">
-    <a href="{{var:homeLink}}" class="control logo">{{var:logo}}</a>
-    <a href="{{var:homeLink}}" class="control title">{{var:name}}</a>
+<div class="nav-main" aria-label="Main navigation" role="menu">
+  <div class="bar width-content">
+    <a class="control logo" role="menuitem" href="{{var:homeLink}}" aria-label="To homepage">{{var:logo}}</a>
+
+    <button
+      class="control burger"
+      aria-label="Toggle menu"
+      aria-haspopup="true"
+      aria-expanded="false"
+      aria-controls="nav-main-menu"
+    >
+      <span class="line"></span>
+      <span class="line"></span>
+      <span class="line"></span>
+    </button>
+    <nav class="menu" role="menubar" id="nav-main-menu" data-animate="menu-show" data-inert="body > .content, body > footer">
+      {{for:menu}}<a class="control" role="menuitem" tabindex="0" href="{{var:href}}"{{if:active}} aria-current="page"{{/if}}>{{var:text}}</a>{{/for}}
+    </nav>
   </div>
-  <div class="menu" role="menubar" id="nav-main-menu">
-    {{for:menu}}<a href="{{var:href}}" class="control" role="menuitem" tabindex="0"{{if:active}} aria-current="page"{{/if}}>{{var:text}}</a>{{/for}}
-  </div>
-</nav>
+</div>

package/templates/partials/section.html

@@ -1 +1 @@
-<section class="text-flow">{{partial:section-inner}}</section>
+<section class="container">{{partial:section-inner}}</section>

package/templates/partials/spaces.html

@@ -4,8 +4,8 @@
     class="item"
     style="--space-value: {{var:value.output}};"
   >
-    <div class="bg"></div>
-    <div class="bg">
+    <div class="bg pxy"></div>
+    <div class="bg pxy info">
       <span class="name">{{var:name}}</span>
       <span class="value">{{var:value.output}}</span>
       <span class="text">{{var:text}}</span>

package/LICENSE.md

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2024
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/assets/src/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function ready(callback: () => void): void;
-export declare function throttle(callback: (...args: any[]) => void, delay: number): (...args: any[]) => void;

package/dist/types/index.d.ts

@@ -1,6 +0,0 @@
-export * from './base';
-export * from './lexer';
-export * from './parser';
-export * from './reader';
-export * from './renderer';
-export * from './token';

package/dist/types/renderer.d.ts

@@ -1,14 +0,0 @@
-import { Renderer as CoreRenderer } from '@ui-doc/core';
-import type { Reader } from './reader';
-export type RenderContext = Record<string, any>;
-export type SourceInput = {
-    source: string;
-    content: string;
-} | Reader;
-export interface Renderer extends CoreRenderer {
-    addLayout(name: string, layout: SourceInput): this;
-    addPartial(name: string, partial: SourceInput): this;
-    addPage(name: string, page: SourceInput): this;
-    page(name: string, context: RenderContext): string;
-    partial(name: string, context?: RenderContext): string;
-}

package/scripts/src/utils.ts

@@ -1,20 +0,0 @@
-export function ready(callback: () => void) {
-  if (document.readyState !== 'loading') {
-    callback()
-  } else {
-    document.addEventListener('DOMContentLoaded', callback)
-  }
-}
-
-export function throttle(callback: (...args: any[]) => void, delay: number) {
-  let timerFlag: number | null = null
-
-  return (...args: any[]) => {
-    if (timerFlag === null) {
-      callback(...args)
-      timerFlag = window.setTimeout(() => {
-        timerFlag = null
-      }, delay)
-    }
-  }
-}

package/styles/02_objects/background.css

@@ -1,7 +0,0 @@
-.bg {
-  --selection-bg-color: var(--font-color);
-  --selection-color: var(--bg-color);
-
-  color: rgb(var(--font-color));
-  background: rgb(var(--bg-color));
-}

package/styles/02_objects/control.css

@@ -1,25 +0,0 @@
-.control {
-  --px: 0;
-  --py: 0;
-
-  @extend .pxy;
-  @extend .font;
-
-  cursor: pointer;
-
-  display: inline-block;
-
-  text-align: center;
-  text-decoration: none;
-
-  appearance: none;
-  background: rgb(var(--control-bg-color, transparent));
-  border: none;
-  border-radius: unset;
-  outline: none;
-
-  &[aria-disabled="true"],
-  &:disabled {
-    cursor: not-allowed;
-  }
-}

package/styles/02_objects/margin.css

@@ -1,44 +0,0 @@
-.margin,
-.mxy {
-  margin: var(--mt, var(--size-normal)) var(--mr, var(--size-normal)) var(--mb, var(--size-normal))
-    var(--ml, var(--size-normal));
-}
-
-.mt {
-  margin-top: var(--mt, var(--size-normal));
-}
-
-.mr {
-  margin-right: var(--mr, var(--size-normal));
-}
-
-.mb {
-  margin-bottom: var(--mb, var(--size-normal));
-}
-
-.ml {
-  margin-left: var(--ml, var(--size-normal));
-}
-
-.mxy {
-  --mt: var(--my, var(--size-normal));
-  --mb: var(--my, var(--size-normal));
-  --ml: var(--mx, var(--size-normal));
-  --mr: var(--mx, var(--size-normal));
-}
-
-.my {
-  --mt: var(--my, var(--size-normal));
-  --mb: var(--my, var(--size-normal));
-
-  @extend .mt;
-  @extend .mb;
-}
-
-.mx {
-  --ml: var(--mx, var(--size-normal));
-  --mr: var(--mx, var(--size-normal));
-
-  @extend .ml;
-  @extend .mr;
-}

package/styles/02_objects/padding.css

@@ -1,44 +0,0 @@
-.padding,
-.pxy {
-  padding: var(--pt, var(--size-normal)) var(--pr, var(--size-normal)) var(--pb, var(--size-normal))
-    var(--pl, var(--size-normal));
-}
-
-.pt {
-  padding-top: var(--pt, var(--size-normal));
-}
-
-.pr {
-  padding-right: var(--pr, var(--size-normal));
-}
-
-.pb {
-  padding-bottom: var(--pb, var(--size-normal));
-}
-
-.pl {
-  padding-left: var(--pl, var(--size-normal));
-}
-
-.pxy {
-  --pt: var(--py, var(--size-normal));
-  --pb: var(--py, var(--size-normal));
-  --pl: var(--px, var(--size-normal));
-  --pr: var(--px, var(--size-normal));
-}
-
-.py {
-  --pt: var(--py, var(--size-normal));
-  --pb: var(--py, var(--size-normal));
-
-  @extend .pt;
-  @extend .pb;
-}
-
-.px {
-  --pl: var(--px, var(--size-normal));
-  --pr: var(--px, var(--size-normal));
-
-  @extend .pl;
-  @extend .pr;
-}

package/styles/02_objects/text.css

@@ -1,3 +0,0 @@
-.tc {
-  color: rgb(var(--font-color));
-}